diff options
Diffstat (limited to 'themes/docsy/userguide/config.toml')
| -rw-r--r-- | themes/docsy/userguide/config.toml | 155 |
1 files changed, 155 insertions, 0 deletions
diff --git a/themes/docsy/userguide/config.toml b/themes/docsy/userguide/config.toml new file mode 100644 index 0000000..012d7e1 --- /dev/null +++ b/themes/docsy/userguide/config.toml @@ -0,0 +1,155 @@ +baseURL = "/" +title = "Docsy Example" + +enableRobotsTXT = true + +# Hugo allows theme composition (and inheritance). The precedence is from left to right. +theme = ["docsy"] + +# Will give values to .Lastmod etc. +enableGitInfo = true + +# Language settings +contentDir = "content/en" +defaultContentLanguage = "en" +defaultContentLanguageInSubdir = false +# Useful when translating. +enableMissingTranslationPlaceholders = true + +disableKinds = ["taxonomy", "taxonomyTerm"] + +# Highlighting config +pygmentsCodeFences = true +pygmentsUseClasses = false +# Use the new Chroma Go highlighter in Hugo. +pygmentsUseClassic = false +#pygmentsOptions = "linenos=table" +# See https://help.farbox.com/pygments.html +pygmentsStyle = "tango" + + # First one is picked as the Twitter card image if not set on page. + #images = ["images/project-illustration.png"] + +# Configure how URLs look like per section. +[permalinks] +blog = "/:section/:year/:month/:day/:slug/" + +## Configuration for BlackFriday markdown parser: https://github.com/russross/blackfriday +[blackfriday] +plainIDAnchors = true +hrefTargetBlank = true +angledQuotes = false +latexDashes = true + +# Image processing configuration. +[imaging] +resampleFilter = "CatmullRom" +quality = 75 +anchor = "smart" + +# Additional menu items + +[[menu.main]] + name = "Example Site" + weight = 40 + url = "https://example.docsy.dev" +[[menu.main]] + name = "GitHub" + weight = 50 + url = "https://github.com/google/docsy/" + +[services] +[services.googleAnalytics] +# Comment out the next line to disable GA tracking. Also disables the feature described in [params.ui.feedback]. +id = "UA-00000000-0" + +# Language configuration + +[languages] +[languages.en] +title = "Docsy" +description = "Docsy does docs" +languageName ="English" +# Weight used for sorting. +weight = 1 + +# Everything below this are Site Params + +[params] +copyright = "Global Inc" +privacy_policy = "https://policies.google.com/privacy" + +# Menu title if your navbar has a versions selector to access old versions of your site. +# This menu appears only if you have at least one [params.versions] set. +version_menu = "Releases" + +# Repository configuration (URLs for in-page links to opening issues and suggesting changes) +github_repo = "https://github.com/google/docsy" +# An optional link to a related project repo. For example, the sibling repository where your product code lives. +github_project_repo = "https://github.com/google/docsy" + +# Specify a value here if your content directory is not in your repo's root directory +github_subdir = "userguide" + +time_format_blog = "Monday, January 02, 2006" +time_format_default = "January 2, 2006" +# Sections to publish in the main RSS feed. +rss_sections = ["blog"] + +# Google Custom Search Engine ID. Remove or comment out to disable search. +gcs_engine_id = "011217106833237091527:la2vtv2emlw" + +# User interface configuration +[params.ui] +# Enable to show the side bar menu in its compact state. +sidebar_menu_compact = false +# Set to true to disable breadcrumb navigation. +breadcrumb_disable = false +# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top nav bar +navbar_logo = true + +# Adds a H2 section titled "Feedback" to the bottom of each doc. The responses are sent to Google Analytics as events. +# This feature depends on [services.googleAnalytics] and will be disabled if "services.googleAnalytics.id" is not set. +# If you want this feature, but occasionally need to remove the "Feedback" section from a single page, +# add "hide_feedback: true" to the page's front matter. +[params.ui.feedback] +enable = true +# The responses that the user sees after clicking "yes" (the page was helpful) or "no" (the page was not helpful). +yes = 'Glad to hear it! Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.' +no = 'Sorry to hear that. Please <a href="https://github.com/USERNAME/REPOSITORY/issues/new">tell us how we can improve</a>.' + +[params.links] +# End user relevant links. These will show up on left side of footer and in the community page if you have one. + [[params.links.user]] + name = "User mailing list" + url = "https://groups.google.com/forum/#!forum/docsy-users" + icon = "fa fa-envelope" + desc = "Discussion and help from your fellow users" +[[params.links.user]] + name ="Twitter" + url = "https://twitter.com/docsydocs" + icon = "fab fa-twitter" + desc = "Follow us on Twitter to get the latest news!" +# [[params.links.user]] + # name = "Stack Overflow" + # url = "https://example.org/stack" + # icon = "fab fa-stack-overflow" + # desc = "Practical questions and curated answers" +# Developer relevant links. These will show up on right side of footer and in the community page if you have one. +[[params.links.developer]] + name = "GitHub" + url = "https://github.com/google/docsy" + icon = "fab fa-github" + desc = "Development takes place here!" +# [[params.links.developer]] + # name = "Slack" + # url = "https://example.org/slack" + # icon = "fab fa-slack" + # desc = "Chat with other project developers" +# [[params.links.developer]] + # name = "Developer mailing list" + # url = "https://example.org/mail" + # icon = "fa fa-envelope" + # desc = "Discuss development issues around the project" + + |