diff --git a/config.toml b/config.toml deleted file mode 100644 index 30548a3..0000000 --- a/config.toml +++ /dev/null @@ -1,283 +0,0 @@ -# # # # # -# Docsy # -# # # # # - -baseURL = "/intradocs" -title = "Intradocs" - -# Language settings -contentDir = "content/en" -defaultContentLanguage = "en" -defaultContentLanguageInSubdir = false -# Useful when translating. -enableMissingTranslationPlaceholders = false - -# Search Engine Optimization -enableRobotsTXT = true - -# Will give values to .Lastmod etc. -enableGitInfo = true - -# Comment out to enable taxonomies in Docsy -# disableKinds = ["taxonomy", "taxonomyTerm"] - -# You can add your own taxonomies -[taxonomies] -tag = "tags" - -[params.taxonomy] -# set taxonomyCloud = [] to hide taxonomy clouds -taxonomyCloud = ["tags"] - -# If used, must have same length as taxonomyCloud -taxonomyCloudTitle = ["Tag Cloud"] - -# set taxonomyPageHeader = [] to hide taxonomies on the page headers -taxonomyPageHeader = ["tags"] - - -# 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" - -# Configure how URLs look like per section. -[permalinks] -blog = "/:section/:year/:month/:day/:slug/" - -# Comment out if you don't want the "print entire section" link enabled. -[outputs] -section = ["HTML", "RSS", "print"] - -# Markdown -[markup] - [markup.goldmark] - footnote = true - [markup.goldmark.parser.attribute] - block = true - title = true - [markup.goldmark.renderer] - unsafe = true - [markup.highlight] - # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html - style = "tango" - # Uncomment if you want your chosen highlight style used for code blocks without a specified language - guessSyntax = "true" - tabWidth = 2 - -# Image processing configuration. -[imaging] -resampleFilter = "CatmullRom" -quality = 85 -anchor = "smart" - -# [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" - -# Community Menu links -[menu] - # [[menu.main]] - # name = "Our Community" - # weight = 50 - # url = "https://example.com" - # pre = "" - -# Language configuration -[languages] -[languages.en] -contentDir = "content/en" -languageName ="English" -time_format_blog = "02/01/2006" -time_format_default = "2006-01-02" -weight = 1 - -# [languages.no] -# contentDir = "content/no" -# languageName ="Norsk" -# time_format_blog = "02.01.2006" -# time_format_default = "02.01.2006" - -# # # # # # # # -# Site Params # -# # # # # # # # - -[params] -copyright = "Example Ltd." -privacy_policy = "/privacy" - -# First one is picked as the Twitter card image if not set on page. -# images = ["images/social_banner.webp"] - -# 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" - -# Flag used in the "version-banner" partial to decide whether to display a -# banner on every page indicating that this is an archived version of the docs. -# Set this flag to "true" if you want to display the banner. -archived_version = false - -# The version number for the version of the docs represented in this doc set. -# Used in the "version-banner" partial to display a version number for the -# current doc set. -version = "1.0" - -# A link to latest version of the docs. Used in the "version-banner" partial to -# point people to the main doc site. -url_latest_version = "https://github.com/joeheaton/intradocs/tree/main" - -# Repository configuration (URLs for in-page links to opening issues and suggesting changes) -github_repo = "https://github.com/joeheaton/intradocs" -# An optional link to a related project repo. For example, the sibling repository where your product code lives. -github_project_repo = "https://github.com/joeheaton/intradocs" - -# Specify a value here if your content directory is not in your repo's root directory -github_subdir = "public" - -# Uncomment this if your GitHub repo does not have "main" as the default branch, -# or specify a new value if you want to reference another branch in your GitHub links -github_branch= "main" - -# Google Custom Search Engine ID. Remove or comment out to disable search. -#gcs_engine_id = "d72aa9b2712488cc3" - -# Enable Algolia DocSearch -algolia_docsearch = false - -# Enable Lunr.js offline search -offlineSearch = true -offlineSearchMaxResults = 25 -offlineSearchSummaryLength = 200 - -# Enable syntax highlighting and copy buttons on code blocks with Prism -prism_syntax_highlighting = true - -# User interface configuration -[params.ui] -# Set to true to disable breadcrumb navigation. -breadcrumb_disable = false -# Set to true to disable the About link in the site footer -footer_about_disable = false -# Set to false if you don't want to display a logo (/assets/icons/logo.svg) in the top navbar -navbar_logo = true -# Set to true if you don't want the top navbar to be translucent when over a `block/cover`, like on the homepage. -navbar_translucent_over_cover_disable = false -# Enable to show the side bar menu in its compact state. -sidebar_menu_compact = true -# Set to true to hide the sidebar search box (the top nav search box will still be displayed if search is enabled) -sidebar_search_disable = false - -# 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 tell us how we can improve.' -no = 'Sorry to hear that. Please tell us how we can improve.' - -# Adds a reading time to the top of each doc. -# If you want this feature, but occasionally need to remove the Reading time from a single page, -# add "hide_readingtime: true" to the page's front matter -[params.ui.readingtime] -enable = true - -# Community links -[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://example.org/mail" - icon = "fa fa-envelope" - desc = "Discussion and help from your fellow users" -[[params.links.user]] - name ="Twitter" - url = "https://example.org/twitter" - 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" - -# # # # # # # -# Libraries # -# # # # # # # - -# Mermaid support -[params.mermaid] -enable = true -theme = "netural" - -[params.mermaid.flowchart] -diagramPadding = 6 - -# UML Diagrams with PlantUML -# [params.plantuml] -# enable = true -# theme = "default" -# -# Set url to plantuml server -# default is http://www.plantuml.com/plantuml/svg/ -# svg_image_url = "https://www.plantuml.com/plantuml/svg/" -# -# By default the plantuml implementation uses tags to display UML diagrams. -# When svg is set to true, diagrams are displayed using tags, maintaining functionality like links e.g. -# default = false -# svg = true - -# MindMap support with MarkMap -[params.markmap] -enable = true - -# KaTeX/LaTeX support -[params.katex] -enable = true -errorColor = "#CD5C5C" - -[params.katex.options] -# If true (the default), KaTeX will throw a ParseError when it encounters an -# unsupported command or invalid LaTeX. If false, KaTeX will render unsupported -# commands as text, and render invalid LaTeX as its source code with hover text -# giving the error, in the color given by errorColor. -throwOnError = false - - -# hugo module configuration - -[module] - # uncomment line below for temporary local development of module - # replacements = "github.com/google/docsy -> ../../docsy" - [module.hugoVersion] - extended = true - min = "0.75.0" - [[module.imports]] - path = "github.com/google/docsy" - disable = false - [[module.imports]] - path = "github.com/google/docsy/dependencies" - disable = false diff --git a/config.yaml b/config.yaml new file mode 100644 index 0000000..8eb5af2 --- /dev/null +++ b/config.yaml @@ -0,0 +1,173 @@ +baseURL: / +title: Intradocs +contentDir: content/en +defaultContentLanguage: en +defaultContentLanguageInSubdir: false # Useful when translating. +enableMissingTranslationPlaceholders: false +enableRobotsTXT: true # Search Engine Optimization +enableGitInfo: true +taxonomies: + tag: tags +params: + images: + - images/social_banner.webp + taxonomy: + taxonomyCloud: + - tags + taxonomyCloudTitle: + - Tag Cloud + taxonomyPageHeader: + - tags + pygmentsCodeFences: true + pygmentsUseClasses: false + pygmentsUseClassic: false + # pygmentsOptions: linenos=table + pygmentsStyle: tango + copyright: Example Ltd. + privacy_policy: /privacy + # Flag used in the "version-banner" partial to decide whether to display a banner on every page indicating that this is an archived version of the docs. Set this flag to "true" if you want to display the banner. + archived_version: true + version_menu: Releases + version_menu_pagelinks: true + version: '1.0' # The version number for the version of the docs represented in this doc set. Used in the "version-banner" partial to display a version number for the current doc set. + versions: + - version: main + url: https://joeheaton.github.io/intradocs/docs/ + # - version: 0.1 + # url: https://joeheaton.github.io/intradocs/docs/ + url_latest_version: 'https://github.com/joeheaton/intradocs/tree/main' # A link to latest version of the docs. Used in the "version-banner" partial to point people to the main doc site. + github_repo: 'https://github.com/joeheaton/intradocs' # Repository configuration (URLs for in-page links to opening issues and suggesting changes) + github_project_repo: 'https://github.com/joeheaton/intradocs' + github_subdir: public + github_branch: main + # gcs_engine_id: d72aa9b2712488cc3 # Google Custom Search Engine ID + algolia_docsearch: false # Enable Algolia DocSearch + # Enable Lunr.js offline search + offlineSearch: true + offlineSearchMaxResults: 25 + offlineSearchSummaryLength: 200 + prism_syntax_highlighting: true + ui: + breadcrumb_disable: false + footer_about_disable: false + navbar_logo: true + navbar_translucent_over_cover_disable: false + sidebar_menu_compact: true + sidebar_search_disable: true + feedback: + enable: true + 'yes': >- + Glad to hear it! Please tell us how we + can improve. + 'no': >- + Sorry to hear that. Please tell us how we + can improve. + readingtime: + enable: true + links: + user: + - name: User mailing list + url: 'https://example.org/mail' + icon: fa fa-envelope + desc: Discussion and help from your fellow users + - name: Twitter + url: 'https://example.org/twitter' + icon: fab fa-twitter + desc: Follow us on Twitter to get the latest news! + - name: Stack Overflow + url: 'https://example.org/stack' + icon: fab fa-stack-overflow + desc: Practical questions and curated answers + developer: + - name: GitHub + url: 'https://github.com/google/docsy' + icon: fab fa-github + desc: Development takes place here! + - name: Slack + url: 'https://example.org/slack' + icon: fab fa-slack + desc: Chat with other project developers + - name: Developer mailing list + url: 'https://example.org/mail' + icon: fa fa-envelope + desc: Discuss development issues around the project + mermaid: + enable: true + theme: netural + flowchart: + diagramPadding: 6 + plantuml: + enable: true + theme: default + svg_image_url: 'https://www.plantuml.com/plantuml/svg/' + # By default the plantuml implementation uses tags to display UML diagrams. + default: false + svg: true + # MindMap support with MarkMap + markmap: + enable: true + # KaTeX/LaTeX support + katex: + enable: true + errorColor: '#CD5C5C' + options: + throwOnError: false +permalinks: + blog: '/:section/:year/:month/:day/:slug/' +outputs: + section: + - HTML + - RSS + - print +# Markdown +markup: + goldmark: + footnote: true + parser: + attribute: + block: true + title: true + renderer: + unsafe: true + highlight: + # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html + style: tango + # Uncomment if you want your chosen highlight style used for code blocks without a specified language + guessSyntax: 'true' + tabWidth: 2 +# Image processing configuration. +imaging: + resampleFilter: CatmullRom + quality: 85 + anchor: smart +# services: +# googleAnalytics: +# id: "UA-00000000-0" +# Menu links +menu: {} + # main: + # name: Our Community + # weight: 50 + # url: http://example.com + # pre: +# Language configuration +languages: + en: + contentDir: content/en + languageName: English + time_format_blog: 02/01/2006 + time_format_default: '2006-01-02' + weight: 1 +module: + hugoVersion: + extended: true + min: 0.75.0 + # uncomment line below for temporary local development of module + # replacement: "github.com/google/docsy -> ../../docsy" + imports: + - path: github.com/google/docsy + disable: false + - path: github.com/google/docsy/dependencies + disable: false