hugo.yaml 4.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149
  1. baseURL: https://www.docsy.dev/
  2. title: Docsy
  3. enableRobotsTXT: true
  4. enableGitInfo: true
  5. theme: [docsy]
  6. ignoreLogs:
  7. # FIXME: find a better way to encode `project` pages than having to ignore warnings.
  8. - warning-frontmatter-params-overrides # cSpell:disable-line
  9. outputs:
  10. home: [HTML]
  11. page: [HTML]
  12. section: [HTML, RSS, print]
  13. imaging:
  14. resampleFilter: CatmullRom # cSpell:disable-line
  15. quality: 75
  16. anchor: smart
  17. menu:
  18. main:
  19. - name: Example Site
  20. weight: 40
  21. url: https://example.docsy.dev
  22. post: <sup><i class="ps-1 fa-solid fa-up-right-from-square fa-xs"
  23. aria-hidden="true"></i></sup>
  24. languages:
  25. en:
  26. languageName: English
  27. params:
  28. description: Docsy does docs
  29. markup:
  30. goldmark:
  31. parser:
  32. attribute:
  33. block: true
  34. extensions:
  35. passthrough:
  36. enable: true
  37. delimiters:
  38. block: [['\[', '\]'], ['$$', '$$']]
  39. inline: [['\(', '\)']]
  40. renderer:
  41. unsafe: true
  42. highlight:
  43. noClasses: false # Required for dark-mode
  44. params:
  45. copyright:
  46. authors: >-
  47. Docsy Authors |
  48. [CC BY 4.0](https://creativecommons.org/licenses/by/4.0) |
  49. from_year: 2018
  50. privacy_policy: https://policies.google.com/privacy
  51. version_menu: Releases
  52. archived_version: false
  53. version: 0.12.0
  54. url_latest_version: https://example.com
  55. github_repo: https://github.com/google/docsy
  56. github_project_repo: https://github.com/google/docsy
  57. github_subdir: userguide
  58. time_format_blog: Monday, January 02, 2006
  59. time_format_default: January 2, 2006
  60. rss_sections: [blog] # TODO: drop since this is the default
  61. gcs_engine_id: 011217106833237091527:la2vtv2emlw # cSpell:disable-line
  62. offlineSearch: false
  63. offlineSearchSummaryLength: 70
  64. offlineSearchMaxResults: 10
  65. prism_syntax_highlighting: false
  66. search:
  67. # algolia:
  68. ui:
  69. showLightDarkModeMenu: true
  70. sidebar_cache_limit: 10
  71. sidebar_menu_compact: true
  72. sidebar_menu_foldable: false
  73. sidebar_search_disable: false
  74. feedback:
  75. enable: true
  76. 'yes': >-
  77. Glad to hear it! Please <a
  78. href="https://github.com/google/docsy/issues/new">tell us how we can
  79. improve</a>.
  80. 'no': >-
  81. Sorry to hear that. Please <a
  82. href="https://github.com/google/docsy/issues/new">tell us how we can
  83. improve</a>.
  84. readingtime:
  85. enable: false
  86. links:
  87. user:
  88. - name: GitHub Discussions
  89. url: https://github.com/google/docsy/discussions
  90. icon: fa-brands fa-github
  91. desc: Discussion and help from your fellow users
  92. - name: User mailing list
  93. url: https://groups.google.com/forum/#!forum/docsy-users
  94. icon: fa-solid fa-envelope
  95. desc: Sign up for Docsy announcements
  96. - name: Twitter
  97. url: https://twitter.com/docsydocs
  98. icon: fa-brands fa-x-twitter
  99. desc: Follow us on Twitter to get the latest news!
  100. - name: Stack Overflow
  101. url: https://stackoverflow.com/questions/tagged/docsy
  102. icon: fa-brands fa-stack-overflow
  103. desc: Practical questions and curated answers
  104. developer:
  105. - name: Project info
  106. url: /project/
  107. icon: fa fa-book
  108. desc: Project design documentation and resources
  109. - name: GitHub
  110. url: https://github.com/google/docsy
  111. icon: fa-brands fa-github
  112. desc: Development takes place here!
  113. plantuml:
  114. enable: true
  115. theme: default
  116. svg_image_url: https://www.plantuml.com/plantuml/svg/
  117. svg: false
  118. print:
  119. disable_toc: false
  120. markmap:
  121. enable: true
  122. drawio:
  123. enable: true
  124. taxonomies:
  125. tag: tags
  126. category: categories
  127. module:
  128. mounts:
  129. - source: content/en
  130. target: content
  131. # Mount the repo's top-level .md files under project
  132. - source: ../README.md
  133. target: content/project/readme.md
  134. - source: ../CHANGELOG.md
  135. target: content/project/changelog.md
  136. - source: ../CONTRIBUTING.md
  137. target: content/project/contributing.md
  138. # cSpell:ignore docsy github goldmark markmap plantuml readingtime userguide