diff options
author | pmikus <peter.mikus@protonmail.ch> | 2023-03-09 13:32:33 +0000 |
---|---|---|
committer | Peter Mikus <peter.mikus@protonmail.ch> | 2023-03-15 10:06:55 +0000 |
commit | b928e56347c682fdb9762ccbe2f368329d4037e4 (patch) | |
tree | 9c0f6a02efc1704821229b8e18a23468fdf8674a /docs/config.toml | |
parent | ddcdf45806d0efa9e89dd4446b4c7da39cfb27a8 (diff) |
feat(docs): Hugo
Signed-off-by: pmikus <peter.mikus@protonmail.ch>
Change-Id: Id8b43ef1f31f39b19a0629c52581514fda278f3b
Diffstat (limited to 'docs/config.toml')
-rw-r--r-- | docs/config.toml | 58 |
1 files changed, 58 insertions, 0 deletions
diff --git a/docs/config.toml b/docs/config.toml new file mode 100644 index 0000000000..3c02a7ee88 --- /dev/null +++ b/docs/config.toml @@ -0,0 +1,58 @@ +baseURL = 'https://csit.fd.io/cdocs' +languageCode = 'en-us' +title = 'CSIT-DOCS' + +publishDir = '../cdash/app/cdocs' + +# (Optional) Set this to true if you use capital letters in file names +disablePathToLower = true + +# (Optional) Set this to true to enable 'Last Modified by' date and git author +# information on 'doc' type pages. +enableGitInfo = false + +# (Optional) Theme is intended for documentation use, therefore it doesn't render taxonomy. +# You can remove related files with config below +disableKinds = ['taxonomy', 'taxonomyTerm'] + +[module] +[[module.imports]] +path = 'github.com/alex-shpak/hugo-book' + +# Needed for mermaid/katex shortcodes +[markup] +[markup.goldmark.renderer] + unsafe = true + +[markup.tableOfContents] + startLevel = 1 + +[params] + # (Optional, default light) Sets color theme: light, dark or auto. + # Theme 'auto' switches between dark and light modes based on browser/os preferences + BookTheme = 'auto' + + # (Optional, default true) Controls table of contents visibility on right side of pages. + # Start and end levels can be controlled with markup.tableOfContents setting. + # You can also specify this parameter per page in front matter. + BookToC = false + + # (Optional, default docs) Specify section of content to render as menu + # You can also set value to "*" to render all sections to menu + BookSection = '*' + + # (Optional, default January 2, 2006) Configure the date format used on the pages + # - In git information + # - In blog posts + BookDateFormat = 'Jan 2, 2006' + + # (Optional, default true) Enables search function with flexsearch, + # Index is built on fly, therefore it might slowdown your website. + # Configuration for indexing can be adjusted in i18n folder per language. + BookSearch = true + + # (Optional, default true) Enables comments template on pages + # By default partials/docs/comments.html includes Disqus template + # See https://gohugo.io/content-management/comments/#configure-disqus + # Can be overwritten by same param in page frontmatter + BookComments = false |