config.toml 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213
  1. baseURL = "/"
  2. title = "Blocktree"
  3. # Language settings
  4. contentDir = "content/en"
  5. defaultContentLanguage = "en"
  6. defaultContentLanguageInSubdir = false
  7. # Useful when translating.
  8. enableMissingTranslationPlaceholders = true
  9. enableRobotsTXT = true
  10. # Will give values to .Lastmod etc.
  11. enableGitInfo = true
  12. # Comment out to enable taxonomies in Docsy
  13. # disableKinds = ["taxonomy", "taxonomyTerm"]
  14. # You can add your own taxonomies
  15. [taxonomies]
  16. tag = "tags"
  17. category = "categories"
  18. [params.taxonomy]
  19. # set taxonomyCloud = [] to hide taxonomy clouds
  20. taxonomyCloud = ["tags", "categories"]
  21. # If used, must have same length as taxonomyCloud
  22. taxonomyCloudTitle = ["Tag Cloud", "Categories"]
  23. # set taxonomyPageHeader = [] to hide taxonomies on the page headers
  24. taxonomyPageHeader = ["tags", "categories"]
  25. # Highlighting config
  26. pygmentsCodeFences = true
  27. pygmentsUseClasses = false
  28. # Use the new Chroma Go highlighter in Hugo.
  29. pygmentsUseClassic = false
  30. #pygmentsOptions = "linenos=table"
  31. # See https://help.farbox.com/pygments.html
  32. pygmentsStyle = "tango"
  33. # Configure what URLs look like per section.
  34. [permalinks]
  35. blog = "/:section/:year/:month/:day/:slug/"
  36. # Image processing configuration.
  37. [imaging]
  38. resampleFilter = "CatmullRom"
  39. quality = 75
  40. anchor = "smart"
  41. [services]
  42. [services.googleAnalytics]
  43. # Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
  44. #id = "UA-00000000-0"
  45. # Language configuration
  46. [languages]
  47. [languages.en]
  48. title = "Blocktree"
  49. languageName ="English"
  50. # Weight used for sorting.
  51. weight = 1
  52. [languages.en.params]
  53. description = "A platform for distributed computing."
  54. [markup]
  55. [markup.goldmark]
  56. [markup.goldmark.renderer]
  57. unsafe = true
  58. [markup.highlight]
  59. # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
  60. style = "tango"
  61. # Uncomment if you want your chosen highlight style used for code blocks without a specified language
  62. # guessSyntax = "true"
  63. # Everything below this are Site Params
  64. # Comment out if you don't want the "print entire section" link enabled.
  65. [outputs]
  66. section = ["HTML", "print", "RSS"]
  67. [params]
  68. copyright = "The Docsy Authors"
  69. privacy_policy = "https://policies.google.com/privacy"
  70. # First one is picked as the Twitter card image if not set on page.
  71. # images = ["images/project-illustration.png"]
  72. # Menu title if your navbar has a versions selector to access old versions of your site.
  73. # This menu appears only if you have at least one [params.versions] set.
  74. version_menu = "Releases"
  75. # Flag used in the "version-banner" partial to decide whether to display a
  76. # banner on every page indicating that this is an archived version of the docs.
  77. # Set this flag to "true" if you want to display the banner.
  78. archived_version = false
  79. # The version number for the version of the docs represented in this doc set.
  80. # Used in the "version-banner" partial to display a version number for the
  81. # current doc set.
  82. version = "0.0"
  83. # A link to latest version of the docs. Used in the "version-banner" partial to
  84. # point people to the main doc site.
  85. url_latest_version = "https://example.com"
  86. # Repository configuration (URLs for in-page links to opening issues and suggesting changes)
  87. github_repo = "https://gogs.delease.com/Delease/Blocktree"
  88. # An optional link to a related project repo. For example, the sibling repository where your product code lives.
  89. github_project_repo = "https://gogs.delease.com/Delease/Blocktree"
  90. # Specify a value here if your content directory is not in your repo's root directory
  91. # github_subdir = ""
  92. # Uncomment this if your GitHub repo does not have "main" as the default branch,
  93. # or specify a new value if you want to reference another branch in your GitHub links
  94. github_branch= "master"
  95. # Google Custom Search Engine ID. Remove or comment out to disable search.
  96. #gcs_engine_id = "d72aa9b2712488cc3"
  97. # Enable Algolia DocSearch
  98. algolia_docsearch = false
  99. # Enable Lunr.js offline search
  100. offlineSearch = true
  101. # Enable syntax highlighting and copy buttons on code blocks with Prism
  102. prism_syntax_highlighting = false
  103. # User interface configuration
  104. [params.ui]
  105. # Set to true to disable breadcrumb navigation.
  106. breadcrumb_disable = false
  107. # Set to true to disable the About link in the site footer
  108. footer_about_disable = false
  109. # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
  110. navbar_logo = true
  111. # Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
  112. navbar_translucent_over_cover_disable = false
  113. # Enable to show the side bar menu in its compact state.
  114. sidebar_menu_compact = false
  115. # Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
  116. sidebar_search_disable = false
  117. # Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
  118. # This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
  119. # If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
  120. # add "hide_feedback: true" to the page's front matter.
  121. [params.ui.feedback]
  122. enable = false
  123. # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
  124. yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
  125. no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
  126. # Adds a reading time to the top of each doc.
  127. # If you want this feature, but occasionally need to remove the Reading time from a single page,
  128. # add "hide_readingtime: true" to the page's front matter
  129. [params.ui.readingtime]
  130. enable = false
  131. [params.links]
  132. # End user relevant links. These will show up on left side of footer and in the community page if you have one.
  133. #[[params.links.user]]
  134. # name = "User mailing list"
  135. # url = "https://example.org/mail"
  136. # icon = "fa fa-envelope"
  137. # desc = "Discussion and help from your fellow users"
  138. #[[params.links.user]]
  139. # name ="Twitter"
  140. # url = "https://example.org/twitter"
  141. # icon = "fab fa-twitter"
  142. # desc = "Follow us on Twitter to get the latest news!"
  143. [[params.links.user]]
  144. name = "Stack Overflow"
  145. url = "https://stackoverflow.com/questions/tagged/blocktree"
  146. icon = "fab fa-stack-overflow"
  147. desc = "Practical questions and curated answers"
  148. # Developer relevant links. These will show up on right side of footer and in the community page if you have one.
  149. [[params.links.developer]]
  150. name = "Repo"
  151. url = "https://gogs.delease.com/Delease/Blocktree"
  152. icon = "fa-solid fa-gear"
  153. desc = "Development takes place here!"
  154. #[[params.links.developer]]
  155. # name = "Slack"
  156. # url = "https://example.org/slack"
  157. # icon = "fab fa-slack"
  158. # desc = "Chat with other project developers"
  159. #[[params.links.developer]]
  160. # name = "Developer mailing list"
  161. # url = "https://example.org/mail"
  162. # icon = "fa fa-envelope"
  163. # desc = "Discuss development issues around the project"
  164. # hugo module configuration
  165. [module]
  166. # uncomment line below for temporary local development of module
  167. # replacements = "github.com/google/docsy -> ../../docsy"
  168. [module.hugoVersion]
  169. extended = true
  170. min = "0.75.0"
  171. [[module.imports]]
  172. path = "github.com/google/docsy"
  173. disable = false
  174. [[module.imports]]
  175. path = "github.com/google/docsy/dependencies"
  176. disable = false