diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index c4d888d997..0f8a216700 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -46,7 +46,7 @@ repo. 3. Update module and package versions: - Update the version of `docsy/dependencies` in [go.mod](go.mod) to v0.X.Y. - Update the NPM package version in [package.json](package.json) to 0.X.Y. -4. Update the Docsy `version` in [userguide/config.toml][] to 0.X.Y. +4. Update the Docsy `version` in [userguide/hugo.toml][] to 0.X.Y. 5. Commit your changes, usually as a PR entitled "Release v0.X.Y preparation". Once the PR is approved and merged, proceed with the remaining steps. 6. Ensure that you're: @@ -96,4 +96,4 @@ repo. [contribution guidelines]: https://www.docsy.dev/docs/contribution-guidelines/ [Draft a new release]: https://github.com/google/docsy/releases/new -[userguide/config.toml]: userguide/config.toml +[userguide/hugo.toml]: userguide/hugo.toml diff --git a/userguide/content/en/docs/Deployment/_index.md b/userguide/content/en/docs/Deployment/_index.md index 8b4d51ac77..c1ce1c7a6f 100644 --- a/userguide/content/en/docs/Deployment/_index.md +++ b/userguide/content/en/docs/Deployment/_index.md @@ -88,25 +88,25 @@ There are several options for publishing your web site using [Amazon Web Service 1. Check the proper configuration of your AWS CLI by issuing the command `aws s3 ls`, this should output a list of your S3 bucket(s). -1. Inside your `config.toml`/`config.yaml`/`config.json`, add a `[deployment]` section like this one: +1. Inside your `hugo.toml`/`hugo.yaml`/`hugo.json`, add a `[deployment]` section like this one: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [deployment] [[deployment.targets]] name = "aws" URL = "s3://www.your-domain.tld" cloudFrontDistributionID = "E9RZ8T1EXAMPLEID" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} deployment: targets: - name: aws URL: 's3://www.your-domain.tld' cloudFrontDistributionID: E9RZ8T1EXAMPLEID {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "deployment": { "targets": [ diff --git a/userguide/content/en/docs/Language/_index.md b/userguide/content/en/docs/Language/_index.md index 7301302c62..e6f5907634 100644 --- a/userguide/content/en/docs/Language/_index.md +++ b/userguide/content/en/docs/Language/_index.md @@ -14,7 +14,7 @@ To add content in multiple languages, you first need to define the available lan {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} contentDir = "content/en" defaultContentLanguage = "en" defaultContentLanguageInSubdir = false @@ -34,7 +34,7 @@ contentDir = "content/no" time_format_default = "02.01.2006" time_format_blog = "02.01.2006" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} contentDir: content/en defaultContentLanguage: en defaultContentLanguageInSubdir: false @@ -53,7 +53,7 @@ languages: time_format_default: 02.01.2006 time_format_blog: 02.01.2006 {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "contentDir": "content/en", "defaultContentLanguage": "en", @@ -83,7 +83,7 @@ Any setting not defined in a `[languages]` block will fall back to the global va Once you've updated your site config, you create a content root directory for each language version in your source repo, such as `content/en` for English text, and add your [content](/docs/adding-content/content/) as usual. See the [Hugo Docs](https://gohugo.io/content-management/multilingual) on multi-language support for more information. {{% alert title="Attention (only when using docsy as hugo module)" color="warning" %}} -If you have a multi language installation, please make sure that the section `[languages]` inside your `config.toml` is declared before the section `[module]` with the module imports. Otherwise you will run into trouble! +If you have a multi language installation, please make sure that the section `[languages]` inside your [configuration file](https://gohugo.io/getting-started/configuration/#configuration-file) is declared **before** the section `[module]` with the module imports. Otherwise you will run into trouble! {{% /alert %}} {{% alert title="Tip" %}} @@ -94,7 +94,7 @@ For adding multiple language versions of other site elements such as button text ## Selecting a language -If you configure more than one language in `config.toml`, the Docsy theme adds a language selector drop down to the top-level menu. Selecting a language takes the user to the translated version of the current page, or the home page for the given language. +If you configure more than one language in your [configuration file](https://gohugo.io/getting-started/configuration/#configuration-file), the Docsy theme adds a language selector drop down to the top-level menu. Selecting a language takes the user to the translated version of the current page, or the home page for the given language. ## Internationalization bundles diff --git a/userguide/content/en/docs/Updating/Convert-site-to-module.md b/userguide/content/en/docs/Updating/Convert-site-to-module.md index eafc353ba5..6ed39d81c4 100644 --- a/userguide/content/en/docs/Updating/Convert-site-to-module.md +++ b/userguide/content/en/docs/Updating/Convert-site-to-module.md @@ -169,6 +169,11 @@ module: You can find details of what these configuration settings do in the [Hugo modules documentation](https://gohugo.io/hugo-modules/configuration/#module-config-top-level). Depending on your environment you may need to tweak them slightly, for example by adding a proxy to use when downloading remote modules. +{{% alert title="Tip" %}} +In Hugo 0.110.0 the default config base filename was changed to `hugo.toml`. +If you are using hugo 0.110 or above, consider renaming your `config.toml` to `hugo.toml`! +{{% /alert %}} + {{% alert title="Attention" color="warning" %}} If you have a multi language installation, please make sure that the section `[languages]` inside your `config.toml` is declared before the section `[module]` with the module imports. Otherwise you will run into trouble! {{% /alert %}} diff --git a/userguide/content/en/docs/adding-content/content.md b/userguide/content/en/docs/adding-content/content.md index 14acbbf16f..fb6419c556 100644 --- a/userguide/content/en/docs/adding-content/content.md +++ b/userguide/content/en/docs/adding-content/content.md @@ -235,23 +235,23 @@ As of version 0.100, [Goldmark](https://github.com/yuin/goldmark/) is the only M

Tip

-If you've been using versions of Hugo before 0.60 that use [`BlackFriday`](https://github.com/russross/blackfriday) as its Markdown parser, you may need to make some small changes to your site to work with the current `Goldmark` Markdown parser. In particular, if you cloned an earlier version of our example site, add the following to your `config.toml`/`config.yaml`/`config.json` to allow Goldmark to render raw HTML as well as Markdown: +If you've been using versions of Hugo before 0.60 that use [`BlackFriday`](https://github.com/russross/blackfriday) as its Markdown parser, you may need to make some small changes to your site to work with the current `Goldmark` Markdown parser. In particular, if you cloned an earlier version of our example site, add the following to your `hugo.toml`/`hugo.yaml`/`hugo.json` to allow Goldmark to render raw HTML as well as Markdown: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [markup] [markup.goldmark] [markup.goldmark.renderer] unsafe = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} markup: goldmark: renderer: unsafe: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "markup": { "goldmark": { @@ -478,11 +478,11 @@ If you've just used the theme, you can still use all Docsy's provided [page bloc ## Adding a community page -The `community` landing page template has boilerplate content that's automatically filled in with the project name and community links specified in `config.toml`/`config.yaml`/`config.json`, providing your users with quick links to resources that help them get involved in your project. The same links are also added by default to your site footer. +The `community` landing page template has boilerplate content that's automatically filled in with the project name and community links specified in `hugo.toml`/`hugo.yaml`/`hugo.json`, providing your users with quick links to resources that help them get involved in your project. The same links are also added by default to your site footer. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [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]] @@ -517,7 +517,7 @@ The `community` landing page template has boilerplate content that's automatical icon = "fa fa-envelope" desc = "Discuss development issues around the project" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: links: user: @@ -547,7 +547,7 @@ params: icon: fa fa-envelope desc: Discuss development issues around the project {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "links": { @@ -609,18 +609,18 @@ You can also use this directory for other files used by your project, including ## RSS feeds -Hugo will, by default, create an RSS feed for the home page and any section. For the main RSS feed you can control which sections to include by setting a site param in your `config.toml`/`config.yaml`/`config.json`. This is the default configuration: +Hugo will, by default, create an RSS feed for the home page and any section. For the main RSS feed you can control which sections to include by setting a site param in your `hugo.toml`/`hugo.yaml`/`hugo.json`. This is the default configuration: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} rss_sections = ["blog"] {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} rss_sections: - blog {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "rss_sections": [ "blog" @@ -629,18 +629,18 @@ rss_sections: {{< /tab >}} {{< /tabpane >}} -To disable all RSS feeds, add the following to your `config.toml`/`config.yaml`/`config.json`: +To disable all RSS feeds, add the following to your `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} disableKinds = ["RSS"] {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} disableKinds: - RSS {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "disableKinds": [ "RSS" @@ -654,22 +654,22 @@ disableKinds:

Note

-If you have enabled our [print feature](/docs/adding-content/print/) or otherwise specified section-level output formats in `config.toml`/`config.yaml`/`config.json`, make sure that `"RSS"` is listed as an output format, otherwise you won't get section-level RSS feeds (and your blog section won't get a nice orange RSS button). Your `config.toml`/`config.yaml`/`config.json` specification overrides the Hugo default [output formats](https://gohugo.io/templates/output-formats/) for sections, which are HTML and RSS. +If you have enabled our [print feature](/docs/adding-content/print/) or otherwise specified section-level output formats in `hugo.toml`/`hugo.yaml`/`hugo.json`, make sure that `"RSS"` is listed as an output format, otherwise you won't get section-level RSS feeds (and your blog section won't get a nice orange RSS button). Your `hugo.toml`/`hugo.yaml`/`hugo.json` specification overrides the Hugo default [output formats](https://gohugo.io/templates/output-formats/) for sections, which are HTML and RSS. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [outputs] section = [ "HTML", "RSS", "print" ] {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} outputs: section: - HTML - RSS - print {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "outputs": { "section": [ @@ -687,23 +687,23 @@ outputs: Hugo creates a `sitemap.xml` file for your generated site by default: for example, [here's the sitemap](/sitemap.xml) for this site. -You can configure the frequency with which your sitemap is updated, your sitemap filename, and the default page priority in your `config.toml`/`config.yaml`/`config.json`: +You can configure the frequency with which your sitemap is updated, your sitemap filename, and the default page priority in your `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [sitemap] changefreq = "monthly" filename = "sitemap.xml" priority = 0.5 {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} sitemap: changefreq: monthly filename: sitemap.xml priority: 0.5 {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "sitemap": { "changefreq": "monthly", diff --git a/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md b/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md index 1c4b62bb59..50451c5d96 100644 --- a/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md +++ b/userguide/content/en/docs/adding-content/diagrams-and-formulae/index.md @@ -87,20 +87,20 @@ math: true {{< /tab >}} {{< /tabpane >}} -If you use formulae in most of your pages, you can also enable sitewide \\(\KaTeX\\) support inside the Docsy theme. To do so update `config.toml`/`config.yaml`/`config.json`: +If you use formulae in most of your pages, you can also enable sitewide \\(\KaTeX\\) support inside the Docsy theme. To do so update `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Site configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.katex] enable = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: katex: enable: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "katex": { @@ -111,11 +111,11 @@ params: {{< /tab >}} {{< /tabpane >}} -Additionally, you can customize various \\(\KaTeX\\) options inside `config.toml`/`config.yaml`/`config.json`, if needed: +Additionally, you can customize various \\(\KaTeX\\) options inside `hugo.toml`/`hugo.yaml`/`hugo.json`, if needed: {{< tabpane persistLang=false >}} {{< tab header="Site configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.katex] # enable/disable KaTeX support enable = true @@ -152,7 +152,7 @@ errorColor = "#CD5C5C" right = "\\]" display = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: katex: enable: true # enable/disable KaTeX support @@ -185,7 +185,7 @@ params: right: \] display: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "katex": { @@ -303,25 +303,25 @@ chem: true {{< /tab >}} {{< /tabpane >}} -If you use formulae in most of your pages, you can also enable sitewide rendering support for chemical formulae inside the Docsy theme. To do so, enable `mhchem` inside your `config.toml`/`config.yaml`/`config.json`: +If you use formulae in most of your pages, you can also enable sitewide rendering support for chemical formulae inside the Docsy theme. To do so, enable `mhchem` inside your `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Site configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.katex] enable = true [params.katex.mhchem] enable = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: katex: enable: true mhchem: enable: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "katex": { @@ -367,20 +367,20 @@ graph TD With hugo version 0.93 or higher, support of Mermaid diagrams is automatically enabled as soon as you use a `mermaid` code block on your page. -If you are using hugo version 0.92 or lower, you need to enable Mermaid manually by updating your `config.toml`/`config.yaml`/`config.json`: +If you are using hugo version 0.92 or lower, you need to enable Mermaid manually by updating your `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Hugo version <= 0.92 only:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.mermaid] enable = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: mermaid: enable: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "mermaid": { @@ -391,25 +391,25 @@ params: {{< /tab >}} {{< /tabpane >}} -If needed, you can define custom settings for your diagrams, such as themes, padding in your `config.toml`/`config.yaml`/`config.json`. +If needed, you can define custom settings for your diagrams, such as themes, padding in your `hugo.toml`/`hugo.yaml`/`hugo.json`. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.mermaid] theme = "neutral" [params.mermaid.flowchart] diagramPadding = 6 {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: mermaid: theme: neutral flowchart: diagramPadding: 6 {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "mermaid": { @@ -475,20 +475,20 @@ Foo -> Foo6 : To collections Foo -> Foo7: To queue ``` -To enable/disable PlantUML, update `config.toml`/`config.yaml`/`config.json`: +To enable/disable PlantUML, update `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.plantuml] enable = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: plantuml: enable: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "plantuml": { @@ -503,7 +503,7 @@ Other optional settings are: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.plantuml] enable = true theme = "default" @@ -517,7 +517,7 @@ svg_image_url = "https://www.plantuml.com/plantuml/svg/" # default = false svg = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: plantuml: enable: true @@ -530,7 +530,7 @@ params: # default = false svg: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "plantuml": { @@ -608,20 +608,20 @@ Automatically renders to: - Katex - $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$ ``` -To enable/disable MarkMap, update `config.toml`/`config.yaml`/`config.json`: +To enable/disable MarkMap, update `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.markmap] enable = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: markmap: enable: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "markmap": { @@ -649,20 +649,20 @@ As the diagram data is transported via the browser, the diagrams.net server does {{< figure src="docsy-diagrams.svg" caption="Mouse over the above image and click the edit button!">}} -To disable detection of diagrams, update `config.toml`/`config.yaml`/`config.json`: +To disable detection of diagrams, update `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.drawio] enable = false {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: drawio: enable: false {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "drawio": { @@ -677,16 +677,16 @@ You can also [deploy and use your own server](https://github.com/jgraph/docker-d {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.drawio] drawio_server = "https://app.mydrawioserver.example.com" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: drawio: drawio_server: 'https://app.mydrawioserver.example.com' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "drawio": { diff --git a/userguide/content/en/docs/adding-content/feedback.md b/userguide/content/en/docs/adding-content/feedback.md index 6e981731ac..a14cf7daab 100644 --- a/userguide/content/en/docs/adding-content/feedback.md +++ b/userguide/content/en/docs/adding-content/feedback.md @@ -36,7 +36,26 @@ configuration file. For details, see [Configure Google Analytics][]. By default, Docsy uses the [gtag.js][] analytics library for both GA4 (which _requires_ `gtag.js`) and Universal Analytics (UA) site tags. If you prefer using the older `analytics.js` library for your UA site tag, then set -`params.disableGtagForUniversalAnalytics` to true in your project's config. +`params.disableGtagForUniversalAnalytics` to `true` in your project's [configuration file]. + +{{< tabpane persistLang=false >}} +{{< tab header="Configuration file:" disabled=true />}} +{{< tab header="hugo.toml" lang="toml" >}} +[params] +disableGtagForUniversalAnalytics = true +{{< /tab >}} +{{< tab header="hugo.yaml" lang="yaml" >}} +params: + disableGtagForUniversalAnalytics: true +{{< /tab >}} +{{< tab header="hugo.json" lang="json" >}} +{ + "params": { + "disableGtagForUniversalAnalytics": true + } +} +{{< /tab >}} +{{< /tabpane >}} {{% alert title="Warning" color="warning" %}} @@ -75,7 +94,7 @@ of every documentation page, as shown in Figure 1. After clicking **Yes** the user should see a response like Figure 2. You can -configure the response text in `config.toml`. +[configure] the response text in the project's [configuration file] `hugo.toml`.
}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.ui.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.' {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: ui: feedback: @@ -138,7 +157,7 @@ params: Sorry to hear that. Please tell us how we can improve. -{{< /tab >}}{{< tab header="config.json" lang="json" >}} +{{< /tab >}}{{< tab header="hugo.json" lang="json" >}} { "params": { @@ -155,7 +174,7 @@ params: {{< /tab >}} {{< /tabpane >}} -4. Save and close `config.toml`/`config.yaml`/`config.json`. +4. Save and close `hugo.toml`/`hugo.yaml`/`hugo.json`. ### Access the feedback data @@ -222,21 +241,21 @@ hide_feedback: true ### Disable feedback on all pages Set `params.ui.feedback.enable` to `false` in -`config.toml`/`config.yaml`/`config.json`: +`hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.ui.feedback] enable = false {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: ui: feedback: enable: false {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "ui": { @@ -300,3 +319,5 @@ partial. For details, see [Customizing templates]({{< ref "lookandfeel#customizi [layouts/partials/page-description.html]: https://github.com/google/docsy/blob/main/layouts/partials/page-description.html [site `params`]: https://gohugo.io/variables/site/#the-siteparams-variable [summary]: https://gohugo.io/content-management/summaries/ +[configure]: #setup-1 +[configuration file]: https://gohugo.io/getting-started/configuration/#configuration-file diff --git a/userguide/content/en/docs/adding-content/iconsimages.md b/userguide/content/en/docs/adding-content/iconsimages.md index 2b8889280f..b14200bc87 100644 --- a/userguide/content/en/docs/adding-content/iconsimages.md +++ b/userguide/content/en/docs/adding-content/iconsimages.md @@ -16,13 +16,13 @@ If you don't want a logo to appear in the navbar, then set `navbar_logo` to {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} navbar_logo = false {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} navbar_logo: false {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "navbar_logo": false } diff --git a/userguide/content/en/docs/adding-content/lookandfeel.md b/userguide/content/en/docs/adding-content/lookandfeel.md index 671a943f65..4026c98d6c 100644 --- a/userguide/content/en/docs/adding-content/lookandfeel.md +++ b/userguide/content/en/docs/adding-content/lookandfeel.md @@ -95,11 +95,11 @@ When you use `.-bg-`, the text colors will be adjusted to get proper cont ## Code highlighting with Chroma -With Hugo version 0.60 and higher, you can choose from a range of code block highlight and colour styles using [Chroma](https://github.com/alecthomas/chroma) that are applied to your fenced code blocks by default. If you copied a recent `config.toml` your site uses Tango (like this site), otherwise the Hugo default is Monokai. You can switch to any of the [available Chroma styles](https://xyproto.github.io/splash/docs/all.html) (including our Docsy default Tango) using your `config.toml`/`config.yaml`/`config.json`: +With Hugo version 0.60 and higher, you can choose from a range of code block highlight and colour styles using [Chroma](https://github.com/alecthomas/chroma) that are applied to your fenced code blocks by default. If you copied a recent `config.toml` your site uses Tango (like this site), otherwise the Hugo default is Monokai. You can switch to any of the [available Chroma styles](https://xyproto.github.io/splash/docs/all.html) (including our Docsy default Tango) using your `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [markup] [markup.goldmark] [markup.goldmark.renderer] @@ -108,7 +108,7 @@ With Hugo version 0.60 and higher, you can choose from a range of code block hig # See a complete list of available styles at https://xyproto.github.io/splash/docs/all.html style = "tango" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} markup: goldmark: renderer: @@ -116,7 +116,7 @@ markup: highlight: style: tango {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "markup": { "goldmark": { @@ -132,18 +132,18 @@ markup: {{< /tab >}} {{< /tabpane >}} -By default code highlighting styles are not applied to code blocks without a specified language, instead you get Docsy's default style of grey with black text. If you would like the code highlighting style to apply to all code blocks, even without a language, uncomment or add the following line under `[markup.highlight]` in your `config.toml`/`config.yaml`/`config.json`. +By default code highlighting styles are not applied to code blocks without a specified language, instead you get Docsy's default style of grey with black text. If you would like the code highlighting style to apply to all code blocks, even without a language, uncomment or add the following line under `[markup.highlight]` in your `hugo.toml`/`hugo.yaml`/`hugo.json`. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} # Uncomment if you want your chosen highlight style used for code blocks without a specified language guessSyntax = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} guessSyntax: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} "guessSyntax": true {{< /tab >}} {{< /tabpane >}} @@ -152,18 +152,18 @@ You can find out more about code highlighting in Hugo with Chroma in [Syntax Hig ## Code highlighting with Prism -Optionally, you can enable Prism syntax highlighting in your `config.toml`/`config.yaml`/`config.json`: +Optionally, you can enable Prism syntax highlighting in your `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} # Enable syntax highlighting and copy buttons on code blocks with Prism prism_syntax_highlighting = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} prism_syntax_highlighting: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} "prism_syntax_highlighting": true {{< /tab >}} {{< /tabpane >}} diff --git a/userguide/content/en/docs/adding-content/navigation.md b/userguide/content/en/docs/adding-content/navigation.md index 5ea3da7e1a..6841ea8c95 100644 --- a/userguide/content/en/docs/adding-content/navigation.md +++ b/userguide/content/en/docs/adding-content/navigation.md @@ -8,9 +8,9 @@ description: > ## Top-level menu -The top level menu (the one that appears in the top navigation bar for the entire site) uses your site's [`main` menu](https://gohugo.io/content-management/menus/). All Hugo sites have a `main` menu array of menu entries, accessible via the `.Site.Menus` site variable and populatable via page front matter or your site's `config.toml`/`config.yaml`/`config.json`. +The top level menu (the one that appears in the top navigation bar for the entire site) uses your site's [`main` menu](https://gohugo.io/content-management/menus/). All Hugo sites have a `main` menu array of menu entries, accessible via the `.Site.Menus` site variable and populatable via page front matter or your site's `hugo.toml`/`hugo.yaml`/`hugo.json`. -To add a page or section to this menu, add it to the site's `main` menu in either `config.toml`/`config.yaml`/`config.json` or in the destination page's front matter (in `_index.md` or `_index.html` for a section, as that's the section landing page). For example, here's how we added the Documentation section landing page to the main menu in this site: +To add a page or section to this menu, add it to the site's `main` menu in either `hugo.toml`/`hugo.yaml`/`hugo.json` or in the destination page's front matter (in `_index.md` or `_index.html` for a section, as that's the section landing page). For example, here's how we added the Documentation section landing page to the main menu in this site: {{< tabpane persistLang=false >}} {{< tab header="Front matter:" disabled=true />}} @@ -50,24 +50,24 @@ menu: The menu is ordered from left to right by page `weight`. So, for example, a section index or page with `weight: 30` would appear after the Documentation section in the menu, while one with `weight: 10` would appear before it. -If you want to add a link to an external site to this menu, add it in `config.toml`/`config.yaml`/`config.json`, specifying the `weight`. +If you want to add a link to an external site to this menu, add it in `hugo.toml`/`hugo.yaml`/`hugo.json`, specifying the `weight`. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [[menu.main]] name = "GitHub" weight = 50 url = "https://github.com/google/docsy/" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} menu: main: - name: GitHub weight: 50 url: 'https://github.com/google/docsy/' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "menu": { "main": [ @@ -84,11 +84,11 @@ menu: ### Adding icons to the top-level menu -As described in the [Hugo docs](https://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu), you can add icons to the top-level menu by using the pre and/or post parameter for main menu items defined in your site's `config.toml`/`config.yaml`/`config.json` or via page front matter. For example, the following configuration adds the GitHub icon to the GitHub menu item, and a **New!** alert to indicate that this is a new addition to the menu. +As described in the [Hugo docs](https://gohugo.io/content-management/menus/#add-non-content-entries-to-a-menu), you can add icons to the top-level menu by using the pre and/or post parameter for main menu items defined in your site's `hugo.toml`/`hugo.yaml`/`hugo.json` or via page front matter. For example, the following configuration adds the GitHub icon to the GitHub menu item, and a **New!** alert to indicate that this is a new addition to the menu. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [[menu.main]] name = "GitHub" weight = 50 @@ -96,7 +96,7 @@ As described in the [Hugo docs](https://gohugo.io/content-management/menus/#add- pre = "" post = "New!" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} menu: main: - name: GitHub @@ -105,7 +105,7 @@ menu: pre: post: New! {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "menu": { "main": [ @@ -126,7 +126,7 @@ You can find a complete list of icons to use in the [FontAwesome documentation]( ### Adding a version drop-down -If you add some `[params.versions]` in `config.toml`, the Docsy theme adds a +If you add some `[params.versions]` in `hugo.toml`, the Docsy theme adds a version selector drop down to the top-level menu. You can find out more in the guide to @@ -134,7 +134,7 @@ You can find out more in the guide to ### Adding a language drop-down -If you configure more than one language in `config.toml`, the Docsy theme adds a language selector drop down to the top-level menu. Selecting a language takes the user to the translated version of the current page, or the home page for the given language. +If you configure more than one language in `hugo.toml`, the Docsy theme adds a language selector drop down to the top-level menu. Selecting a language takes the user to the translated version of the current page, or the home page for the given language. You can find out more in [Multi-language support](/docs/language/). @@ -217,14 +217,47 @@ description: > ### Section menu options -By default, the section menu shows the current section fully expanded all the way down. This may make the left nav too long and difficult to scan for bigger sites. Try setting site parameter `ui.sidebar_menu_compact = true` in `config.toml`. +By default, the section menu shows the current section fully expanded all the way down. This may make the left nav too long and difficult to scan for bigger sites. Try setting site parameter `ui.sidebar_menu_compact = true` in `hugo.toml`. With the compact menu (`.ui.sidebar_menu_compact = true`), only the current page's ancestors, siblings and direct descendants are shown. You can use the optional parameter `.ui.ul_show` to set a desired menu depth to always be visible. For example, with `.ui.ul_show = 1` the first menu level is always displayed. -As well as the completely expanded and compact menu options, you can also create a foldable menu by setting the site parameter `ui.sidebar_menu_foldable = true` in `config.toml`. The foldable menu lets users expand and collapse menu sections by toggling arrow icons beside the section parents in the menu. +As well as the completely expanded and compact menu options, you can also create a foldable menu by setting the site parameter `ui.sidebar_menu_foldable = true` in `hugo.toml`. The foldable menu lets users expand and collapse menu sections by toggling arrow icons beside the section parents in the menu. On large sites (default: > 2000 pages) the section menu is not generated for each page, but cached for the whole section. The HTML classes for marking the active menu item (and menu path) are then set using JS. You can adjust the limit for activating the cached section menu with the optional parameter `.ui.sidebar_cache_limit`. +The tabbed pane below lists the menu section options you can define in your project [configuration file]. + +{{< tabpane persistLang=false >}} +{{< tab header="Configuration file:" disabled=true />}}{{< tab header="hugo.toml" lang="toml" >}} +[params.ui] +sidebar_menu_compact = true +ul_show = 1 +sidebar_menu_foldable = true +sidebar_cache_limit = 1000 +{{< /tab >}} +{{< tab header="hugo.yaml" lang="yaml" >}} +params: + ui: + sidebar_menu_compact: true + ul_show: 1 + sidebar_menu_foldable: true + sidebar_cache_limit: 1000 +{{< /tab >}} +{{< tab header="hugo.json" lang="json" >}} +{ + "params": { + "ui": { + "sidebar_menu_compact": true, + "ul_show": 1, + "sidebar_menu_foldable": true, + "sidebar_cache_limit": 1000, + } + } +} +{{< /tab >}} +{{< /tabpane >}} + + ### Add icons to the section menu You can add icons to the section menu in the sidebar by setting the `icon` parameter in the page front matter (e.g. `icon: fa-solid fa-screwdriver-wrench`). @@ -247,9 +280,35 @@ To create a placeholder page, create a page file as usual in the directory where ## Breadcrumb navigation -Breadcrumb navigation links appear at the top of each page by default. To disable breadcrumb navigation, set site param `ui.breadcrumb_disable = true` in `config.toml`. +Breadcrumb navigation links appear at the top of each page by default. To disable breadcrumb navigation, set site param `ui.breadcrumb_disable = true` in `hugo.toml`. -Breadcrumb navigation links are also shown for each item on the taxonomy results page (i.e. when you click one of the taxonomy labels, e.g. Tags/Categories). These breadcrumbs can be disabled in `config.toml` by setting site param `taxonomy_breadcrumb_disable = true`. +Breadcrumb navigation links are also shown for each item on the taxonomy results page (i.e. when you click one of the taxonomy labels, e.g. Tags/Categories). These breadcrumbs can be disabled in `hugo.toml` by setting site param `ui.taxonomy_breadcrumb_disable = true`. + +The tabbed pane below lists the breadcrumb navigation options you can define in your project [configuration file]. + +{{< tabpane persistLang=false >}} +{{< tab header="Configuration file:" disabled=true />}}{{< tab header="hugo.toml" lang="toml" >}} +[params.ui] +breadcrumb_disable = true +taxonomy_breadcrumb_disable = true +{{< /tab >}} +{{< tab header="hugo.yaml" lang="yaml" >}} +params: + ui: + breadcrumb_disable: true + taxonomy_breadcrumb_disable: true +{{< /tab >}} +{{< tab header="hugo.json" lang="json" >}} +{ + "params": { + "ui": { + "breadcrumb_disable": true, + "taxonomy_breadcrumb_disable": true + } + } +} +{{< /tab >}} +{{< /tabpane >}} ## Site search options @@ -259,23 +318,23 @@ Docsy offers multiple options that let your readers search your site content, so * [Algolia DocSearch](#configure-algolia-docsearch), which uses Algolia's indexing and search mechanism, and provides an organized dropdown of search results when your readers use the search box. Algolia DocSearch is free for public documentation sites. * [Local search with Lunr](#configure-local-search-with-lunr), which uses Javascript to index and search your site without the need to connect to external services. This option doesn't require your site to be public. -If you enable any of these search options in your `config.toml`, a search box displays in the right of your top navigation bar. By default a search box also displays at the top of the section menu in the left navigation pane, which you can disable if you prefer, or if you're using a search option that only works with the top search box. +If you enable any of these search options in your project [configuration file], a search box displays in the right of your top navigation bar. By default a search box also displays at the top of the section menu in the left navigation pane, which you can disable if you prefer, or if you're using a search option that only works with the top search box. -Be aware that if you accidentally enable more than one search option in your `config.toml` you may get unexpected results (for example, if you have added the `.js` for Algolia DocSearch, you'll get Algolia results if you enable GCSE search but forget to disable Algolia search). +Be aware that if you accidentally enable more than one search option in your project [configuration file], you may get unexpected results (for example, if you have added the `.js` for Algolia DocSearch, you'll get Algolia results if you enable GCSE search but forget to disable Algolia search). ### Disabling the sidebar search box -By default, the search box appears in both the top navigation bar and at the top of the sidebar left navigation pane. If you don't want the sidebar search box, set `sidebar_search_disable` to `true` in `config.toml`/`config.yaml`/`config.json`: +By default, the search box appears in both the top navigation bar and at the top of the sidebar left navigation pane. If you don't want the sidebar search box, set `sidebar_search_disable` to `true` in `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} sidebar_search_disable = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} sidebar_search_disable: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} "sidebar_search_disable": true {{< /tab >}} {{< /tabpane >}} @@ -324,17 +383,17 @@ layout: search {{< /tab >}} {{< /tabpane >}} -1. Add your Google Custom Search Engine ID to the site params in `config.toml`/`config.yaml`/`config.json`. You can add different values per language if needed. +1. Add your Google Custom Search Engine ID to the site params in `hugo.toml`/`hugo.yaml`/`hugo.json`. You can add different values per language if needed. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} gcs_engine_id = "011737558837375720776:fsdu1nryfng" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} gcs_engine_id: '011737558837375720776:fsdu1nryfng' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "gcs_engine_id": "011737558837375720776:fsdu1nryfng" } @@ -362,26 +421,26 @@ If you are accepted to the program, you will receive the code to add to your doc ### Adding Algolia DocSearch -1. Enable Algolia DocSearch in `config.toml`/`config.yaml`/`config.json`. +1. Enable Algolia DocSearch in `hugo.toml`/`hugo.yaml`/`hugo.json`. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} algolia_docsearch = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} algolia_docsearch: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "algolia_docsearch": true } {{< /tab >}} {{< /tabpane >}} -2. Remove or comment out any GCSE ID in `config.toml`/`config.yaml`/`config.json` and ensure local search is set to `false` as you can only have one type of search enabled. See [Disabling GCSE search](#disabling-gcse-search). +2. Remove or comment out any GCSE ID in `hugo.toml`/`hugo.yaml`/`hugo.json` and ensure local search is set to `false` as you can only have one type of search enabled. See [Disabling GCSE search](#disabling-gcse-search). -3. Disable the sidebar search in `config.toml`/`config.yaml`/`config.json` as this is not currently supported for Algolia DocSearch. See [Disabling the sidebar search box](#disabling-the-sidebar-search-box). +3. Disable the sidebar search in `hugo.toml`/`hugo.yaml`/`hugo.json` as this is not currently supported for Algolia DocSearch. See [Disabling the sidebar search box](#disabling-the-sidebar-search-box). 3. Add the CSS and JS to use Algolia to the head and body of every page in your site, following the instructions in [Add code to head or before body end](/docs/adding-content/lookandfeel/#add-code-to-head-or-before-body-end). @@ -414,24 +473,24 @@ When you've completed these steps, Algolia search should be enabled on your site To add Lunr search to your Docsy site: -1. Enable local search in `config.toml`/`config.yaml`/`config.json`. +1. Enable local search in `hugo.toml`/`hugo.yaml`/`hugo.json`. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} offlineSearch = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} offlineSearch: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "offlineSearch": true } {{< /tab >}} {{< /tabpane >}} -2. Remove or comment out any GCSE ID in `config.toml`/`config.yaml`/`config.json` and ensure Algolia DocSearch is set to `false`, as you can only have one type of search enabled. See [Disabling GCSE search](#disabling-gcse-search). +2. Remove or comment out any GCSE ID in `hugo.toml`/`hugo.yaml`/`hugo.json` and ensure Algolia DocSearch is set to `false`, as you can only have one type of search enabled. See [Disabling GCSE search](#disabling-gcse-search). Once you've completed these steps, local search is enabled for your site and results appear in a drop down when you use the search box. @@ -441,20 +500,20 @@ If you're [testing this locally](/docs/deployment/#serving-your-site-locally) us ### Changing the summary length of the local search results -You can customize the summary length by setting `offlineSearchSummaryLength` in `config.toml`/`config.yaml`/`config.json`. +You can customize the summary length by setting `offlineSearchSummaryLength` in `hugo.toml`/`hugo.yaml`/`hugo.json`. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} #Enable offline search with Lunr.js offlineSearch = true offlineSearchSummaryLength = 200 {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} offlineSearch: true offlineSearchSummaryLength: 200 {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "offlineSearch": true, "offlineSearchSummaryLength": 200 @@ -464,19 +523,19 @@ offlineSearchSummaryLength: 200 ### Changing the maximum result count of the local search -You can customize the maximum result count by setting `offlineSearchMaxResults` in `config.toml`/`config.yaml`/`config.json`. +You can customize the maximum result count by setting `offlineSearchMaxResults` in `hugo.toml`/`hugo.yaml`/`hugo.json`. {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} offlineSearch = true offlineSearchMaxResults = 25 {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} offlineSearch: true offlineSearchMaxResults: 25 {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "offlineSearch": true, "offlineSearchMaxResults": 25 @@ -524,3 +583,5 @@ exclude_search: true } {{< /tab >}} {{< /tabpane >}} + +[configuration file]: https://gohugo.io/getting-started/configuration/#configuration-file \ No newline at end of file diff --git a/userguide/content/en/docs/adding-content/print.md b/userguide/content/en/docs/adding-content/print.md index b29fef6fea..b17113aa32 100644 --- a/userguide/content/en/docs/adding-content/print.md +++ b/userguide/content/en/docs/adding-content/print.md @@ -10,22 +10,22 @@ Individual documentation pages print well from most browsers as the layouts have On some sites, it can be useful to enable a "print entire section" feature (as seen in this user guide). Selecting this option renders the entire current top-level section (such as Content and Customization for this page) with all of its child pages and sections in a format suited to printing, complete with a table of contents for the section. -To enable this feature, add the "print" output format in your site's `config.toml`/`config.yaml`/`config.json` file for the "section" type: +To enable this feature, add the "print" output format in your site's `hugo.toml`/`hugo.yaml`/`hugo.json` file for the "section" type: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [outputs] section = [ "HTML", "RSS", "print" ] {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} outputs: section: - HTML - RSS - print {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "outputs": { "section": [ @@ -44,7 +44,7 @@ The site should then show a "Print entire section" link in the right hand naviga ### Disabling the ToC -To disable showing the the table of contents in the printable view, set the `disable_toc` param to `true`, either in the page front matter, or in `config.toml`/`config.yaml`/`config.json`: +To disable showing the the table of contents in the printable view, set the `disable_toc` param to `true`, either in the page front matter, or in `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Front matter:" disabled=true />}} @@ -70,16 +70,16 @@ disable_toc: true } {{< /tab >}} {{< tab header="or config file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.print] disable_toc = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: print: disable_toc: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "print": { diff --git a/userguide/content/en/docs/adding-content/repository-links.md b/userguide/content/en/docs/adding-content/repository-links.md index 07ebc05501..151ec9d1b2 100644 --- a/userguide/content/en/docs/adding-content/repository-links.md +++ b/userguide/content/en/docs/adding-content/repository-links.md @@ -18,7 +18,7 @@ Currently, Docsy supports only GitHub repository links "out of the box". Since G ## Link configuration -There are four variables you can configure in `config.toml`/`config.yaml`/`config.json` to set up links, as well as one in your page metadata. +There are four variables you can configure in `hugo.toml`/`hugo.yaml`/`hugo.json` to set up links, as well as one in your page metadata. ### `github_repo` @@ -26,13 +26,13 @@ The URL for your site's source repository. This is used to generate the **Edit t {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} github_repo = "https://github.com/google/docsy" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} github_repo: 'https://github.com/google/docsy' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "github_repo": "https://github.com/google/docsy" } @@ -45,13 +45,13 @@ Specify a value here if your content directory is not in your repo's root direct {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} github_subdir = "userguide" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} github_subdir: 'userguide' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "github_subdir": "userguide" } @@ -64,13 +64,13 @@ Specify a value here if you have a separate project repo and you'd like your use {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} github_project_repo = "https://github.com/google/docsy" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} github_project_repo: 'https://github.com/google/docsy' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "github_project_repo": "https://github.com/google/docsy" } @@ -83,13 +83,13 @@ Specify a value here if you have would like to reference a different branch for {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} github_branch = "release" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} github_branch: 'release' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "github_branch": "release" } diff --git a/userguide/content/en/docs/adding-content/shortcodes/index.md b/userguide/content/en/docs/adding-content/shortcodes/index.md index 2eda403c90..5c00557b9e 100644 --- a/userguide/content/en/docs/adding-content/shortcodes/index.md +++ b/userguide/content/en/docs/adding-content/shortcodes/index.md @@ -652,7 +652,7 @@ To create a new pipeline, follow the next steps: ``` -This code automatically reads the content of `import/config.yaml` and inserts it +This code automatically reads the content of `includes/config.yaml` and inserts it into the document. The rendered text looks like this: --- diff --git a/userguide/content/en/docs/adding-content/taxonomy.md b/userguide/content/en/docs/adding-content/taxonomy.md index 94785d0ded..82968951aa 100644 --- a/userguide/content/en/docs/adding-content/taxonomy.md +++ b/userguide/content/en/docs/adding-content/taxonomy.md @@ -27,21 +27,21 @@ A example taxonomy for a movie website you can find in the official Hugo docs: h ## Parameters -There are various parameter to control the functionality of taxonomies in the `config.toml`. +There are various parameter to control the functionality of taxonomies in the project [configuration file]. -By default taxonomies for `tags` and `categories` are enabled in Hugo (see: https://gohugo.io/content-management/taxonomies/#default-taxonomies). In Docsy taxonomies are __disabled__ by default in the `config.toml`/`config.yaml`/`config.json`: +By default taxonomies for `tags` and `categories` are enabled in Hugo (see: https://gohugo.io/content-management/taxonomies/#default-taxonomies). In Docsy taxonomies are __disabled__ by default in the `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} disableKinds = ["taxonomy", "taxonomyTerm"] {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} disableKinds: - taxonomy - taxonomyTerm {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "disableKinds": [ "taxonomy", @@ -51,25 +51,25 @@ disableKinds: {{< /tab >}} {{< /tabpane >}} -If you want to enable taxonomies in Docsy you have to delete (or comment out) this line in your projects `config.toml`/`config.yaml`/`config.json`. Then the taxonomy pages for `tags` and `categories` will be generated by Hugo. If you want to use other taxonomies you have to define them in your `config.toml`. If you want to use beside your own taxonomies also the default taxonomies `tags` and `categories`, you also have to define them beside your own taxonomies. You need to provide both the plural and singular labels for each taxonomy. +If you want to enable taxonomies in Docsy you have to delete (or comment out) this line in your project's `hugo.toml`/`hugo.yaml`/`hugo.json`. Then the taxonomy pages for `tags` and `categories` will be generated by Hugo. If you want to use other taxonomies you have to define them in your [configuration file]. If you want to use beside your own taxonomies also the default taxonomies `tags` and `categories`, you also have to define them beside your own taxonomies. You need to provide both the plural and singular labels for each taxonomy. With the following example you define a additional taxonomy `projects` beside the default taxonomies `tags` and `categories`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [taxonomies] tag = "tags" category = "categories" project = "projects" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} taxonomies: tag: tags category: categories project: projects {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "taxonomies": { "tag": "tags", @@ -80,17 +80,17 @@ taxonomies: {{< /tab >}} {{< /tabpane >}} -You can use the following parameters in your projects `config.toml`/`config.yaml`/`config.json` to control the output of the assigned taxonomy terms for each article resp. page of your docs and/or blog section in Docsy or a "tag cloud" in Docsy's right sidebar: +You can use the following parameters in your project's `hugo.toml`/`hugo.yaml`/`hugo.json` to control the output of the assigned taxonomy terms for each article resp. page of your docs and/or blog section in Docsy or a "tag cloud" in Docsy's right sidebar: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [params.taxonomy] taxonomyCloud = ["projects", "tags"] # set taxonomyCloud = [] to hide taxonomy clouds taxonomyCloudTitle = ["Our Projects", "Tag Cloud"] # if used, must have same length as taxonomyCloud taxonomyPageHeader = ["tags", "categories"] # set taxonomyPageHeader = [] to hide taxonomies on the page headers {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: taxonomy: taxonomyCloud: @@ -103,7 +103,7 @@ params: - tags # remove all entries - categories # to hide taxonomy clouds {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "taxonomy": { @@ -169,7 +169,7 @@ This will gave you for each in the current page (resp. context) defined taxonomy ### taxonomy_terms_article_wrapper -The partial `taxonomy_terms_article_wrapper` is a wrapper for the partial `taxonomy_terms_article` with the only parameter `context` (most of the time the current page or context `.`) and checks the taxonomy parameters of your project's `config.toml`/`config.yaml`/`config.json` to loop threw all listed taxonomies in the parameter `taxonomyPageHeader` resp. all defined taxonomies of your page, if `taxonomyPageHeader` isn't set. +The partial `taxonomy_terms_article_wrapper` is a wrapper for the partial `taxonomy_terms_article` with the only parameter `context` (most of the time the current page or context `.`) and checks the taxonomy parameters of your project's `hugo.toml`/`hugo.yaml`/`hugo.json` to loop threw all listed taxonomies in the parameter `taxonomyPageHeader` resp. all defined taxonomies of your page, if `taxonomyPageHeader` isn't set. ### taxonomy_terms_cloud @@ -199,8 +199,10 @@ As an example this will gave you for following HTML markup for the taxonomy `cat ### taxonomy_terms_clouds -The partial `taxonomy_terms_clouds` is a wrapper for the partial `taxonomy_terms_cloud` with the only parameter `context` (most of the time the current page or context `.`) and checks the taxonomy parameters of your project's `config.toml`/`config.yaml`/`config.json` to loop threw all listed taxonomies in the parameter `taxonomyCloud` resp. all defined taxonomies of your page, if `taxonomyCloud` isn't set. +The partial `taxonomy_terms_clouds` is a wrapper for the partial `taxonomy_terms_cloud` with the only parameter `context` (most of the time the current page or context `.`) and checks the taxonomy parameters of your project's `hugo.toml`/`hugo.yaml`/`hugo.json` to loop threw all listed taxonomies in the parameter `taxonomyCloud` resp. all defined taxonomies of your page, if `taxonomyCloud` isn't set. ## Multi language support for taxonomies The taxonomy terms associated content gets only counted and linked WITHIN the language! The control parameters for the taxonomy support can also get assigned language specific. + +[configuration file]: https://gohugo.io/getting-started/configuration/#configuration-file \ No newline at end of file diff --git a/userguide/content/en/docs/adding-content/versioning.md b/userguide/content/en/docs/adding-content/versioning.md index 340a0fb70a..ade8ad11b5 100644 --- a/userguide/content/en/docs/adding-content/versioning.md +++ b/userguide/content/en/docs/adding-content/versioning.md @@ -14,13 +14,13 @@ to display an information banner on the archived sites. ## Adding a version drop-down menu -If you add some `[params.versions]` in `config.toml`/`config.yaml`/`config.json`, the Docsy theme adds a +If you add some `[params.versions]` in `hugo.toml`/`hugo.yaml`/`hugo.json`, the Docsy theme adds a version selector drop down to the top-level menu. You specify a URL and a name for each version you would like to add to the menu, as in the following example: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} # Add your release versions here [[params.versions]] version = "master" @@ -34,7 +34,7 @@ for each version you would like to add to the menu, as in the following example: version = "v0.3" url = "https://v0-3.kubeflow.org" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} params: versions: - version: master @@ -44,7 +44,7 @@ params: - version: v0.3 url: 'https://v0-3.kubeflow.org' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "params": { "versions": [ @@ -69,17 +69,17 @@ params: Remember to add your current version so that users can navigate back! The default title for the version drop-down menu is **Releases**. To change the -title, change the `version_menu` parameter in `config.toml`/`config.yaml`/`config.json`: +title, change the `version_menu` parameter in `hugo.toml`/`hugo.yaml`/`hugo.json`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} version_menu = "Releases" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} version_menu: 'Releases' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} "version_menu": "Releases" {{< /tab >}} {{< /tabpane >}} @@ -111,19 +111,19 @@ For example, see the archived docs for
To add the banner to your doc site, make the following changes in your -`config.toml`/`config.yaml`/`config.json` file: +`hugo.toml`/`hugo.yaml`/`hugo.json` file: 1. Set the `archived_version` parameter to `true`: {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} archived_version = true {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} archived_version: true {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} "archived_version": true {{< /tab >}} {{< /tabpane >}} @@ -133,13 +133,13 @@ archived_version: true {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} version = "0.1" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} version: '0.1' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} "version": "0.1" {{< /tab >}} {{< /tabpane >}} @@ -150,13 +150,13 @@ version: '0.1' {{< tabpane persistLang=false >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} url_latest_version = "https://your-latest-doc-site.com" {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} url_latest_version: 'https://your-latest-doc-site.com' {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} "url_latest_version": "https://your-latest-doc-site.com" {{< /tab >}} {{< /tabpane >}} diff --git a/userguide/content/en/docs/get-started/basic-configuration.md b/userguide/content/en/docs/get-started/basic-configuration.md index 19875ea429..ed9c45487b 100644 --- a/userguide/content/en/docs/get-started/basic-configuration.md +++ b/userguide/content/en/docs/get-started/basic-configuration.md @@ -7,7 +7,7 @@ description: > Basic configuration for new Docsy sites. --- -Site-wide configuration details and parameters are defined in your project's `config.toml` file. These include your chosen Hugo theme (Docsy, of course!), project name, community links, Google Analytics configuration, and Markdown parser parameters. See the examples with comments in [`config.toml` in the example project](https://github.com/google/docsy-example/blob/master/config.toml) for how to add this information. **We recommend copying this config.toml and editing it even if you’re just using the theme and not copying the entire Docsy example site**, as it includes default values for many parameters that you need to set for your site to build correctly. +Site-wide configuration details and parameters are defined in your project's [configuration file] (`config.toml` or `hugo.toml`). These include your chosen Hugo theme (Docsy, of course!), project name, community links, Google Analytics configuration, and Markdown parser parameters. See the examples with comments in [`config.toml` in the example project](https://github.com/google/docsy-example/blob/master/config.toml) for how to add this information. **We recommend copying this config.toml and editing it even if you’re just using the theme and not copying the entire Docsy example site**, as it includes default values for many parameters that you need to set for your site to build correctly. You may want to remove or customize some defaults of the copied `config.toml` file straight away: @@ -52,3 +52,5 @@ To use your own Custom Search Engine, replace the value in the `gcs_engine_id` w * [Add content and customize your site](/docs/adding-content/) * Get some ideas from our [Example Site](https://github.com/google/docsy-example) and other [Examples](/docs/examples/). * [Publish your site](/docs/deployment/). + +[configuration file]: https://gohugo.io/getting-started/configuration/#configuration-file diff --git a/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md b/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md index 1122f198c5..2dcf506cbc 100644 --- a/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md +++ b/userguide/content/en/docs/get-started/docsy-as-module/start-from-scratch.md @@ -68,7 +68,12 @@ hugo new site my-new-site cd my-new-site ``` -This will create a minimal site structure, containing the folders `archetypes`, `content`, `data`, `layouts`, `static`, and `themes` and a configuration file, `config.toml. +This will create a minimal site structure, containing the folders `archetypes`, `content`, `data`, `layouts`, `static`, and `themes` and a configuration file (default: `config.toml`). + +{{% alert title="Tip" %}} +In Hugo 0.110.0 the default config base filename was changed to `hugo.toml`. +If you are using hugo 0.110 or above, consider renaming your `config.toml` to `hugo.toml`! +{{% /alert %}} ### Import the Docsy theme module as a dependency of your site @@ -90,11 +95,11 @@ This command adds the `docsy` theme module to your definition file `go.mod`. ### Add theme module configuration settings -Add the settings in the following snippet at the end of your site configuration file (default: `config.toml`) and save the file. +Add the settings in the following snippet at the end of your site's [configuration file] (default: `config.toml`) and save the file. {{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} -{{< tab header="config.toml" lang="toml" >}} +{{< tab header="hugo.toml" lang="toml" >}} [module] proxy = "direct" # uncomment line below for temporary local development of module @@ -109,7 +114,7 @@ Add the settings in the following snippet at the end of your site configuration path = "github.com/google/docsy/dependencies" disable = false {{< /tab >}} -{{< tab header="config.yaml" lang="yaml" >}} +{{< tab header="hugo.yaml" lang="yaml" >}} module: proxy: direct hugoVersion: @@ -121,7 +126,7 @@ module: - path: github.com/google/docsy/dependencies disable: false {{< /tab >}} -{{< tab header="config.json" lang="json" >}} +{{< tab header="hugo.json" lang="json" >}} { "module": { "proxy": "direct", @@ -165,3 +170,5 @@ You may get Hugo errors for missing parameters and values when you try to build * [Add content and customize your site](/docs/adding-content/) * Get some ideas from our [Example Site](https://github.com/google/docsy-example) and other [Examples](/docs/examples/). * [Publish your site](/docs/deployment/). + +[configuration file]: https://gohugo.io/getting-started/configuration/#configuration-file \ No newline at end of file diff --git a/userguide/content/en/docs/get-started/other-options.md b/userguide/content/en/docs/get-started/other-options.md index 96787091b8..1001fb1019 100644 --- a/userguide/content/en/docs/get-started/other-options.md +++ b/userguide/content/en/docs/get-started/other-options.md @@ -170,6 +170,11 @@ your project's root directory: echo 'theme = "docsy"' >> config.toml ``` + {{% alert title="Tip" %}} +In Hugo 0.110.0 the default config base filename was changed to `hugo.toml`. +If you are using hugo 0.110 or above, consider renaming your `config.toml` to `hugo.toml`! + {{% /alert %}} + 3. Get Docsy dependencies: ```sh