config.toml 7.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212
  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. description = "A platform for distributed computing."
  50. languageName ="English"
  51. # Weight used for sorting.
  52. weight = 1
  53. [markup]
  54. [markup.goldmark]
  55. [markup.goldmark.renderer]
  56. unsafe = true
  57. [markup.highlight]
  58. # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html
  59. style = "tango"
  60. # Uncomment if you want your chosen highlight style used for code blocks without a specified language
  61. # guessSyntax = "true"
  62. # Everything below this are Site Params
  63. # Comment out if you don't want the "print entire section" link enabled.
  64. [outputs]
  65. section = ["HTML", "print", "RSS"]
  66. [params]
  67. copyright = "The Docsy Authors"
  68. privacy_policy = "https://policies.google.com/privacy"
  69. # First one is picked as the Twitter card image if not set on page.
  70. # images = ["images/project-illustration.png"]
  71. # Menu title if your navbar has a versions selector to access old versions of your site.
  72. # This menu appears only if you have at least one [params.versions] set.
  73. version_menu = "Releases"
  74. # Flag used in the "version-banner" partial to decide whether to display a
  75. # banner on every page indicating that this is an archived version of the docs.
  76. # Set this flag to "true" if you want to display the banner.
  77. archived_version = false
  78. # The version number for the version of the docs represented in this doc set.
  79. # Used in the "version-banner" partial to display a version number for the
  80. # current doc set.
  81. version = "0.0"
  82. # A link to latest version of the docs. Used in the "version-banner" partial to
  83. # point people to the main doc site.
  84. url_latest_version = "https://example.com"
  85. # Repository configuration (URLs for in-page links to opening issues and suggesting changes)
  86. github_repo = "https://gogs.delease.com/Delease/Blocktree"
  87. # An optional link to a related project repo. For example, the sibling repository where your product code lives.
  88. github_project_repo = "https://gogs.delease.com/Delease/Blocktree"
  89. # Specify a value here if your content directory is not in your repo's root directory
  90. # github_subdir = ""
  91. # Uncomment this if your GitHub repo does not have "main" as the default branch,
  92. # or specify a new value if you want to reference another branch in your GitHub links
  93. github_branch= "master"
  94. # Google Custom Search Engine ID. Remove or comment out to disable search.
  95. #gcs_engine_id = "d72aa9b2712488cc3"
  96. # Enable Algolia DocSearch
  97. algolia_docsearch = false
  98. # Enable Lunr.js offline search
  99. offlineSearch = true
  100. # Enable syntax highlighting and copy buttons on code blocks with Prism
  101. prism_syntax_highlighting = false
  102. # User interface configuration
  103. [params.ui]
  104. # Set to true to disable breadcrumb navigation.
  105. breadcrumb_disable = false
  106. # Set to true to disable the About link in the site footer
  107. footer_about_disable = false
  108. # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar
  109. navbar_logo = true
  110. # Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage.
  111. navbar_translucent_over_cover_disable = false
  112. # Enable to show the side bar menu in its compact state.
  113. sidebar_menu_compact = false
  114. # Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
  115. sidebar_search_disable = false
  116. # Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
  117. # This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
  118. # If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
  119. # add "hide_feedback: true" to the page's front matter.
  120. [params.ui.feedback]
  121. enable = false
  122. # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
  123. yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
  124. no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.'
  125. # Adds a reading time to the top of each doc.
  126. # If you want this feature, but occasionally need to remove the Reading time from a single page,
  127. # add "hide_readingtime: true" to the page's front matter
  128. [params.ui.readingtime]
  129. enable = false
  130. [params.links]
  131. # End user relevant links. These will show up on left side of footer and in the community page if you have one.
  132. #[[params.links.user]]
  133. # name = "User mailing list"
  134. # url = "https://example.org/mail"
  135. # icon = "fa fa-envelope"
  136. # desc = "Discussion and help from your fellow users"
  137. #[[params.links.user]]
  138. # name ="Twitter"
  139. # url = "https://example.org/twitter"
  140. # icon = "fab fa-twitter"
  141. # desc = "Follow us on Twitter to get the latest news!"
  142. [[params.links.user]]
  143. name = "Stack Overflow"
  144. url = "https://stackoverflow.com/questions/tagged/blocktree"
  145. icon = "fab fa-stack-overflow"
  146. desc = "Practical questions and curated answers"
  147. # Developer relevant links. These will show up on right side of footer and in the community page if you have one.
  148. [[params.links.developer]]
  149. name = "Repo"
  150. url = "https://gogs.delease.com/Delease/Blocktree"
  151. icon = "fa-solid fa-gear"
  152. desc = "Development takes place here!"
  153. #[[params.links.developer]]
  154. # name = "Slack"
  155. # url = "https://example.org/slack"
  156. # icon = "fab fa-slack"
  157. # desc = "Chat with other project developers"
  158. #[[params.links.developer]]
  159. # name = "Developer mailing list"
  160. # url = "https://example.org/mail"
  161. # icon = "fa fa-envelope"
  162. # desc = "Discuss development issues around the project"
  163. # hugo module configuration
  164. [module]
  165. # uncomment line below for temporary local development of module
  166. # replacements = "github.com/google/docsy -> ../../docsy"
  167. [module.hugoVersion]
  168. extended = true
  169. min = "0.75.0"
  170. [[module.imports]]
  171. path = "github.com/google/docsy"
  172. disable = false
  173. [[module.imports]]
  174. path = "github.com/google/docsy/dependencies"
  175. disable = false