config.toml 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168
  1. baseURL = "https://mudler.github.io/edgevpn/docs/"
  2. title = "EdgeVPN"
  3. enableRobotsTXT = true
  4. # Hugo allows theme composition (and inheritance). The precedence is from left to right.
  5. theme = ["docsy"]
  6. # Will give values to .Lastmod etc.
  7. enableGitInfo = true
  8. # Language settings
  9. contentDir = "content/en"
  10. defaultContentLanguage = "en"
  11. defaultContentLanguageInSubdir = false
  12. # Useful when translating.
  13. enableMissingTranslationPlaceholders = true
  14. disableKinds = ["taxonomy", "taxonomyTerm"]
  15. # Highlighting config
  16. pygmentsCodeFences = true
  17. pygmentsUseClasses = false
  18. # Use the new Chroma Go highlighter in Hugo.
  19. pygmentsUseClassic = false
  20. #pygmentsOptions = "linenos=table"
  21. # See https://help.farbox.com/pygments.html
  22. pygmentsStyle = "tango"
  23. # Configure how URLs look like per section.
  24. [permalinks]
  25. blog = "/:section/:year/:month/:day/:slug/"
  26. ## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday
  27. [blackfriday]
  28. plainIDAnchors = true
  29. hrefTargetBlank = true
  30. angledQuotes = false
  31. latexDashes = true
  32. # Image processing configuration.
  33. [imaging]
  34. resampleFilter = "CatmullRom"
  35. quality = 75
  36. anchor = "smart"
  37. [services]
  38. [services.googleAnalytics]
  39. # Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback].
  40. id = "UA-00000000-0"
  41. # Language configuration
  42. [languages]
  43. [languages.en]
  44. title = "EdgeVPN"
  45. languageName ="English"
  46. # Weight used for sorting.
  47. weight = 1
  48. #[languages.it]
  49. #title = "EdgeVPN"
  50. #languageName ="Italian"
  51. #contentDir = "content/it"
  52. #time_format_default = "02.01.2006"
  53. #time_format_blog = "02.01.2006"
  54. [[menu.main]]
  55. name = "Contribution guidelines"
  56. weight = 50
  57. url = "https://github.com/mudler/edgevpn/contribute"
  58. pre = "<i class='fab fa-github'></i>"
  59. post = ""
  60. [markup]
  61. [markup.goldmark]
  62. [markup.goldmark.renderer]
  63. unsafe = true
  64. # Everything below this are Site Params
  65. [params]
  66. copyright = "Ettore Di Giacinto"
  67. privacy_policy = "https://policies.google.com/privacy"
  68. # First one is picked as the Twitter card image if not set on page.
  69. # images = ["images/project-illustration.png"]
  70. # Menu title if your navbar has a versions selector to access old versions of your site.
  71. # This menu appears only if you have at least one [params.versions] set.
  72. version_menu = "Releases"
  73. # Repository configuration (URLs for in-page links to opening issues and suggesting changes)
  74. github_repo = "https://github.com/mudler/edgevpn"
  75. # An optional link to a related project repo. For example, the sibling repository where your product code lives.
  76. github_project_repo = "https://github.com/mudler/edgevpn"
  77. # Specify a value here if your content directory is not in your repo's root directory
  78. github_subdir = "docs"
  79. # Google Custom Search Engine ID. Remove or comment out to disable search.
  80. #gcs_engine_id = "011737558837375720776:fsdu1nryfng"
  81. # Enable Algolia DocSearch
  82. algolia_docsearch = false
  83. # Enable Lunr.js offline search
  84. offlineSearch = true
  85. # User interface configuration
  86. [params.ui]
  87. # Enable to show the side bar menu in its compact state.
  88. sidebar_menu_compact = false
  89. # Set to true to disable breadcrumb navigation.
  90. breadcrumb_disable = true
  91. # Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled)
  92. sidebar_search_disable = false
  93. # Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar
  94. navbar_logo = true
  95. # Set to true to disable the About link in the site footer
  96. footer_about_disable = false
  97. # Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events.
  98. # This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set.
  99. # If you want this feature, but occasionally need to remove the "Feedback" section from a single page,
  100. # add "hide_feedback: true" to the page's front matter.
  101. [params.ui.feedback]
  102. enable = true
  103. # The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful).
  104. yes = 'Glad to hear it! Please <a href="https://github.com/mudler/edgevpn/issues/new">tell us how we can improve</a>.'
  105. no = 'Sorry to hear that. Please <a href="https://github.com/mudler/edgevpn/issues/new">tell us how we can improve</a>.'
  106. [params.links]
  107. # End user relevant links. These will show up on left side of footer and in the community page if you have one.
  108. # [[params.links.user]]
  109. # name = "User mailing list"
  110. # url = "https://example.org/mail"
  111. # icon = "fa fa-envelope"
  112. # desc = "Discussion and help from your fellow users"
  113. # [[params.links.user]]
  114. # name ="Twitter"
  115. # url = "https://example.org/twitter"
  116. # icon = "fab fa-twitter"
  117. # desc = "Follow us on Twitter to get the latest news!"
  118. # [[params.links.user]]
  119. # name = "Stack Overflow"
  120. # url = "https://example.org/stack"
  121. # icon = "fab fa-stack-overflow"
  122. # desc = "Practical questions and curated answers"
  123. # Developer relevant links. These will show up on right side of footer and in the community page if you have one.
  124. [[params.links.developer]]
  125. name = "GitHub"
  126. url = "https://github.com/mudler/edgevpn"
  127. icon = "fab fa-github"
  128. desc = "Development takes place here!"
  129. [[params.links.user]]
  130. name = "GitHub Discussions"
  131. url = "https://github.com/mudler/edgevpn/discussions"
  132. icon = "fab fa-github"
  133. desc = "Discussion and help from your fellow users"
  134. [[params.links.user]]
  135. name = "Matrix chat"
  136. url = "https://matrix.to/#/#edgevpn:matrix.org"
  137. icon = "fas fa-comments"
  138. desc = "Join us on Matrix!"
  139. # [[params.links.developer]]
  140. # name = "Developer mailing list"
  141. # url = "https://example.org/mail"
  142. # icon = "fa fa-envelope"
  143. # desc = "Discuss development issues around the project"