|
|
@@ -0,0 +1,122 @@
|
|
|
+baseURL: http://0.0.0.0:1313/
|
|
|
+title: Documentation
|
|
|
+theme: hugo-book
|
|
|
+
|
|
|
+copyright: "This is a copyright placeholder"
|
|
|
+
|
|
|
+# Book configuration
|
|
|
+disablePathToLower: true
|
|
|
+enableGitInfo: true
|
|
|
+
|
|
|
+# Needed for mermaid/katex shortcodes
|
|
|
+markup:
|
|
|
+ goldmark:
|
|
|
+ renderer:
|
|
|
+ unsafe: true
|
|
|
+ tableOfContents:
|
|
|
+ startLevel: 1
|
|
|
+ highlight:
|
|
|
+ style: base16-snazzy
|
|
|
+
|
|
|
+# Multi-lingual mode config
|
|
|
+# There are different options to translate files
|
|
|
+# See https://gohugo.io/content-management/multilingual/#translation-by-filename
|
|
|
+# And https://gohugo.io/content-management/multilingual/#translation-by-content-directory
|
|
|
+# languages:
|
|
|
+# en:
|
|
|
+# languageName: English
|
|
|
+# contentDir: content
|
|
|
+# weight: 1
|
|
|
+# zh:
|
|
|
+# languageName: Chinese
|
|
|
+# contentDir: content.zh
|
|
|
+# weight: 2
|
|
|
+# he:
|
|
|
+# languageName: Hebrew
|
|
|
+# contentDir: content.he
|
|
|
+# languageDirection: rtl
|
|
|
+# weight: 3
|
|
|
+
|
|
|
+menu:
|
|
|
+ home:
|
|
|
+ - name: "Documentation"
|
|
|
+ pageRef: "/docs/"
|
|
|
+ weight: 10
|
|
|
+ - name: "Github"
|
|
|
+ url: "https://github.com/alex-shpak/hugo-book/"
|
|
|
+ weight: 20
|
|
|
+
|
|
|
+ # before: []
|
|
|
+ after:
|
|
|
+ - name: "Github"
|
|
|
+ url: "https://github.com/alex-shpak/hugo-book"
|
|
|
+ weight: 10
|
|
|
+
|
|
|
+taxonomies:
|
|
|
+ tag: tags
|
|
|
+
|
|
|
+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: "light"
|
|
|
+
|
|
|
+ # (Optional, default none) 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: true
|
|
|
+
|
|
|
+ # (Optional, default favicon.png) Set the path to a favicon file.
|
|
|
+ # If the favicon is /static/favicon.png then the path would be favicon.png
|
|
|
+ # BookFavicon: "favicon.png"
|
|
|
+
|
|
|
+ # (Optional, default none) Set the path to a logo for the book.
|
|
|
+ # If the logo is /static/logo.png then the path would be logo.png
|
|
|
+ # BookLogo: /logo.png
|
|
|
+
|
|
|
+ # (Optional, default docs) Specify root page to render child pages as menu.
|
|
|
+ # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/
|
|
|
+ # For backward compatibility you can set '*' to render all sections to menu. Acts same as '/'
|
|
|
+ # BookSection: docs
|
|
|
+
|
|
|
+ # (Optional, default none) Set template for commit link for the page. Requires enableGitInfo.
|
|
|
+ # When set enabled 'Last Modified' and a link to the commit in the footer of the page.
|
|
|
+ # Param is executed as template using .Site, .Page and .GitInfo as context.
|
|
|
+ # BookLastChangeLink: 'https://github.com/alex-shpak/hugo-book/commit/{{ .GitInfo.Hash }}'
|
|
|
+
|
|
|
+ # (Optional, default none) Set template for edit page link.
|
|
|
+ # When set enabled 'Edit this page' link in the footer of the page.
|
|
|
+ # Param is executed as template using .Site, .Page and .Path as context.
|
|
|
+ # BookEditLink: 'https://github.com/alex-shpak/hugo-book/edit/main/exampleSite/{{ .Path }}'
|
|
|
+
|
|
|
+ # (Optional, default 'January 2, 2006') Configure the date format used on the pages
|
|
|
+ # - In git information
|
|
|
+ # - In blog posts
|
|
|
+ # https://gohugo.io/functions/time/format/
|
|
|
+ # BookDateFormat: "January 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 partals/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
|
|
|
+
|
|
|
+ # /!\ This is an experimental feature, might be removed or changed at any time
|
|
|
+ # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
|
|
|
+ # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
|
|
|
+ # Theme will print warning or error if page referenced in markdown does not exists.
|
|
|
+ # Possible values are false | 'warning' | 'error'
|
|
|
+ BookPortableLinks: 'warning'
|
|
|
+
|
|
|
+ # /!\ This is an experimental feature, might be removed or changed at any time
|
|
|
+ # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
|
|
|
+ # can be false, true or 'precache', precache will try to download all content pages on install.
|
|
|
+ BookServiceWorker: 'precache'
|
|
|
+
|
|
|
+ # /!\ This is an experimental feature, might be removed or changed at any time
|
|
|
+ # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
|
|
|
+ BookTranslatedOnly: false
|