baseURL = 'https://example.com/' title = 'Lyceum Docs' # Book configuration enableGitInfo = true # (Optional) Theme is intended for documentation use, therefore it doesn't render taxonomy. # You can remove related files with config below disableKinds = ['taxonomy'] # Needed for mermaid/katex shortcodes [markup] [markup.goldmark.renderer] unsafe = true [markup.tableOfContents] startLevel = 1 # 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] [languages.en] languageName = 'English' contentDir = 'content' weight = 1 [[menu.before]] name='home' url='/' weight=0 [[menu.after]] name="Dont Be Evil Licence" url="/license" weight=10 [[menu.after]] name="Support the project" url="/donate" weight=20 [[menu.after]] name="Source" url = "https://git.sr.ht/~aethrvmn/lyceum-site" weight=30 [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 = 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.ico' # (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' # Set source repository location. # Used for 'Last Modified' and 'Edit this page' links. BookRepo = 'https://git.sr.ht/~aethrvmn/lyceum-site' # (Optional, default 'commit') Specifies commit portion of the link to the page's last modified # commit hash for 'doc' page type. # Requires 'BookRepo' param. # Value used to construct a URL consisting of BookRepo/BookCommitPath/ # Github uses 'commit', Bitbucket uses 'commits' BookCommitPath = 'commit' # Enable "Edit this page" links for 'doc' page type. # Disabled by default. Uncomment to enable. Requires 'BookRepo' param. # Edit path must point to root directory of repo. # BookEditPath = 'edit/main/exampleSite' # (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 # /!\ 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 if page referenced in markdown does not exists. BookPortableLinks = true # /!\ 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. BookServiceWorker = true # /!\ 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