github.com/alimy/mir/v4@v4.1.0/docs/config.toml (about)

     1  # hugo server --minify --themesDir ... --baseURL=http://0.0.0.0:1313/theme/hugo-book/
     2  
     3  baseURL = 'https://alimy.me/mir'
     4  title = 'Mir Docs'
     5  theme = 'hugo-book'
     6  defaultContentLanguage = 'zh'
     7  languageCode = "zh"
     8  
     9  # Book configuration
    10  disablePathToLower = true
    11  enableGitInfo = true
    12  
    13  # Needed for mermaid/katex shortcodes
    14  [markup]
    15  [markup.goldmark.renderer]
    16    unsafe = true
    17  
    18  [markup.tableOfContents]
    19    startLevel = 1
    20  
    21  # Multi-lingual mode config
    22  # There are different options to translate files
    23  # See https://gohugo.io/content-management/multilingual/#translation-by-filename
    24  # And https://gohugo.io/content-management/multilingual/#translation-by-content-directory
    25  [languages]
    26  [languages.zh]
    27    languageCode = "zh"
    28    languageName = '中文'
    29    contentDir = 'content.zh'
    30    title = 'Mir 文档'
    31    weight = 1
    32  
    33  [languages.en]
    34    languageCode = "en"
    35    languageName = 'English'
    36    contentDir = 'content.en'
    37    title = 'Mir Docs'
    38    weight = 2
    39  
    40  [menu]
    41  # [[menu.before]]
    42  [[menu.after]]
    43    name = "Github"
    44    url = "https://github.com/alimy/mir"
    45    weight = 10
    46  
    47  [[menu.after]]
    48    name = "Alimy's Me"
    49    url = "https://alimy.me/"
    50    weight = 20
    51  
    52  [[menu.after]]
    53    name = "Hugo's Theme"
    54    url = "https://themes.gohugo.io/hugo-book/"
    55    weight = 30
    56  
    57  [params]
    58    # (Optional, default light) Sets color theme: light, dark or auto.
    59    # Theme 'auto' switches between dark and light modes based on browser/os preferences
    60    BookTheme = 'auto'
    61  
    62    # (Optional, default true) Controls table of contents visibility on right side of pages.
    63    # Start and end levels can be controlled with markup.tableOfContents setting.
    64    # You can also specify this parameter per page in front matter.
    65    BookToC = true
    66  
    67    # (Optional, default none) Set the path to a logo for the book. If the logo is
    68    # /static/logo.png then the path would be logo.png
    69    BookLogo = 'images/mir-logo.png'
    70  
    71    # (Optional, default none) Set leaf bundle to render as side menu
    72    # When not specified file structure and weights will be used
    73    # BookMenuBundle = '/menu'
    74  
    75    # (Optional, default docs) Specify root page to render child pages as menu.
    76    # Page is resoled by .GetPage function: https://gohugo.io/functions/getpage/
    77    # For backward compatibility you can set '*' to render all sections to menu. Acts same as '/'
    78    BookSection = 'docs'
    79  
    80    # Set source repository location.
    81    # Used for 'Last Modified' and 'Edit this page' links.
    82    BookRepo = 'https://github.com/alimy/mir/'
    83  
    84    # (Optional, default 'commit') Specifies commit portion of the link to the page's last modified
    85    # commit hash for 'doc' page type.
    86    # Requires 'BookRepo' param.
    87    # Value used to construct a URL consisting of BookRepo/BookCommitPath/<commit-hash>
    88    # Github uses 'commit', Bitbucket uses 'commits'
    89    #BookCommitPath = 'commit'
    90  
    91    # Enable "Edit this page" links for 'doc' page type.
    92    # Disabled by default. Uncomment to enable. Requires 'BookRepo' param.
    93    # Edit path must point to root directory of repo.
    94    #BookEditPath = 'edit/main/docs'
    95  
    96    # Configure the date format used on the pages
    97    # - In git information
    98    # - In blog posts
    99    BookDateFormat = 'January 2, 2006'
   100  
   101    # (Optional, default true) Enables search function with flexsearch,
   102    # Index is built on fly, therefore it might slowdown your website.
   103    # Configuration for indexing can be adjusted in i18n folder per language.
   104    BookSearch = true
   105  
   106    # (Optional, default true) Enables comments template on pages
   107    # By default partals/docs/comments.html includes Disqus template
   108    # See https://gohugo.io/content-management/comments/#configure-disqus
   109    # Can be overwritten by same param in page frontmatter
   110    # BookComments = true
   111  
   112    # /!\ This is an experimental feature, might be removed or changed at any time
   113    # (Optional, experimental, default false) Enables portable links and link checks in markdown pages.
   114    # Portable links meant to work with text editors and let you write markdown without {{< relref >}} shortcode
   115    # Theme will print warning if page referenced in markdown does not exists.
   116    BookPortableLinks = true
   117  
   118    # /!\ This is an experimental feature, might be removed or changed at any time
   119    # (Optional, experimental, default false) Enables service worker that caches visited pages and resources for offline use.
   120    BookServiceWorker = true
   121  
   122    # /!\ This is an experimental feature, might be removed or changed at any time
   123    # (Optional, experimental, default false) Enables a drop-down menu for translations only if a translation is present.
   124    BookTranslatedOnly = false