feat(docs): Hugo
[csit.git] / docs / config.toml
1 baseURL = 'https://csit.fd.io/cdocs'
2 languageCode = 'en-us'
3 title = 'CSIT-DOCS'
4
5 publishDir = '../cdash/app/cdocs'
6
7 # (Optional) Set this to true if you use capital letters in file names
8 disablePathToLower = true
9
10 # (Optional) Set this to true to enable 'Last Modified by' date and git author
11 #  information on 'doc' type pages.
12 enableGitInfo = false
13
14 # (Optional) Theme is intended for documentation use, therefore it doesn't render taxonomy.
15 # You can remove related files with config below
16 disableKinds = ['taxonomy', 'taxonomyTerm']
17
18 [module]
19 [[module.imports]]
20 path = 'github.com/alex-shpak/hugo-book'
21
22 # Needed for mermaid/katex shortcodes
23 [markup]
24 [markup.goldmark.renderer]
25   unsafe = true
26
27 [markup.tableOfContents]
28   startLevel = 1
29
30 [params]
31   # (Optional, default light) Sets color theme: light, dark or auto.
32   # Theme 'auto' switches between dark and light modes based on browser/os preferences
33   BookTheme = 'auto'
34
35   # (Optional, default true) Controls table of contents visibility on right side of pages.
36   # Start and end levels can be controlled with markup.tableOfContents setting.
37   # You can also specify this parameter per page in front matter.
38   BookToC = false
39
40   # (Optional, default docs) Specify section of content to render as menu
41   # You can also set value to "*" to render all sections to menu
42   BookSection = '*'
43
44   # (Optional, default January 2, 2006) Configure the date format used on the pages
45   # - In git information
46   # - In blog posts
47   BookDateFormat = 'Jan 2, 2006'
48
49   # (Optional, default true) Enables search function with flexsearch,
50   # Index is built on fly, therefore it might slowdown your website.
51   # Configuration for indexing can be adjusted in i18n folder per language.
52   BookSearch = true
53
54   # (Optional, default true) Enables comments template on pages
55   # By default partials/docs/comments.html includes Disqus template
56   # See https://gohugo.io/content-management/comments/#configure-disqus
57   # Can be overwritten by same param in page frontmatter
58   BookComments = false