From a08224ca6f7e90f209c75500589d99a54d3c16d2 Mon Sep 17 00:00:00 2001 From: Patrice Chalin Date: Wed, 5 Jul 2023 12:12:25 -0400 Subject: [PATCH] Drop persistLang=false from UG pages --- .../content/en/docs/adding-content/content.md | 30 +++++++++---------- .../diagrams-and-formulae/index.md | 24 +++++++-------- .../en/docs/adding-content/feedback.md | 8 ++--- .../en/docs/adding-content/iconsimages.md | 2 +- .../en/docs/adding-content/lookandfeel.md | 6 ++-- .../en/docs/adding-content/navigation.md | 30 +++++++++---------- .../content/en/docs/adding-content/print.md | 4 +-- .../docs/adding-content/repository-links.md | 18 +++++------ .../docs/adding-content/shortcodes/index.md | 4 +-- .../en/docs/adding-content/taxonomy.md | 6 ++-- .../en/docs/adding-content/versioning.md | 10 +++---- .../content/en/docs/deployment/_index.md | 4 +-- userguide/content/en/docs/language/_index.md | 2 +- 13 files changed, 74 insertions(+), 74 deletions(-) diff --git a/userguide/content/en/docs/adding-content/content.md b/userguide/content/en/docs/adding-content/content.md index 6f711b1bb3..88c070826a 100644 --- a/userguide/content/en/docs/adding-content/content.md +++ b/userguide/content/en/docs/adding-content/content.md @@ -34,7 +34,7 @@ If you've copied the example site, you already have appropriately named top-leve If you've copied the example site and *don't* want to use one of the provided content sections, just delete the appropriate content subdirectory. Similarly, if you want to add a top-level section, just add a new subdirectory, though you'll need to specify the layout or content type explicitly in the [frontmatter](#page-frontmatter) of each page if you want to use any existing Docsy template other than the default one. For example, if you create a new directory `content/en/amazing` and want one or more pages in that custom section to use Docsy's `docs` template, you add `type: docs` to the frontmatter of each page: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -79,7 +79,7 @@ Since Hugo 0.76, this has become practical without copying layouts to your site, For example, for the `/news/` section, you can specify the following front matter in the index page which will change the type of the section and everything below it to "blog": -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -126,7 +126,7 @@ cascade: If you want to create a "docs" site, specifying something like the following in the top level `_index.md` will set all top level sections to be treated as "docs", except for "news": -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -192,7 +192,7 @@ Each page file in a Hugo site has metadata frontmatter that tells Hugo about the For example, here's the frontmatter for this page: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -237,7 +237,7 @@ As of version 0.100, [Goldmark](https://github.com/yuin/goldmark/) is the only M 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [markup] @@ -320,7 +320,7 @@ By default a docs section landing page (the `_index.md` or `_index.html` in the To display a simple bulleted list of links to the section's pages instead, specify `simple_list: true` in the landing page's frontmatter: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -347,7 +347,7 @@ weight: 20 To display no links at all, specify `no_list: true` in the landing page's frontmatter: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -378,7 +378,7 @@ Docsy's `blog` layout also gives you a left nav menu (like the `docs` layout), a To create different blog categories to organize your posts, create subfolders in `blog/`. For instance, in our [example site](https://github.com/google/docsy-example/tree/main/content/en/blog) we have `news` and `releases`. Each category needs to have its own `_index.md` or `_index.html` landing page file specifying the category title for it to appear properly in the left nav and top-level blog landing page. Here's the index page for `releases`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -405,7 +405,7 @@ weight: 20 To add author and date information to blog posts, add them to the page frontmatter: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -480,7 +480,7 @@ If you've just used the theme, you can still use all Docsy's provided [page bloc 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.links] @@ -611,7 +611,7 @@ You can also use this directory for other files used by your project, including 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} rss_sections = ["blog"] @@ -631,7 +631,7 @@ rss_sections: To disable all RSS feeds, add the following to your `hugo.toml`/`hugo.yaml`/`hugo.json`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} disableKinds = ["RSS"] @@ -656,7 +656,7 @@ disableKinds: 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [outputs] @@ -689,7 +689,7 @@ Hugo creates a `sitemap.xml` file for your generated site by default: for exampl 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [sitemap] @@ -716,7 +716,7 @@ sitemap: To override any of these values for a given page, specify it in page frontmatter: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ 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 a1b8cba84f..3b444b9d8e 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 @@ -67,7 +67,7 @@ As soon as you use a `math` code block on your page, support of \\(\KaTeX\\) is If you want to use inline formulae and don't have a `math` code block present in your page which triggers auto activation, you need to manually activate \\(\KaTeX\\) support. The easiest way to do so is to add a `math` attribute to the frontmatter of your page and set it to `true`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Page front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -88,7 +88,7 @@ math: true 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 >}} +{{< tabpane >}} {{< tab header="Site configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.katex] @@ -112,7 +112,7 @@ params: Additionally, you can customize various \\(\KaTeX\\) options inside `hugo.toml`/`hugo.yaml`/`hugo.json`, if needed: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Site configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.katex] @@ -283,7 +283,7 @@ As soon as you use a `chem` code block on your page, rendering support for chemi If you want to use chemical formulae inline and don't have a `chem` code block present in your page which triggers auto activation, you need to manually activate rendering support for chemical formulae. The easiest way to do so is to add a `chem` attribute to the frontmatter of your page and set it to `true`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Page front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -304,7 +304,7 @@ chem: true 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 >}} +{{< tabpane >}} {{< tab header="Site configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.katex] @@ -368,7 +368,7 @@ With hugo version 0.93 or higher, support of Mermaid diagrams is automatically e 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 >}} +{{< tabpane >}} {{< tab header="Hugo version <= 0.92 only:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.mermaid] @@ -392,7 +392,7 @@ params: 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.mermaid] @@ -476,7 +476,7 @@ Foo -> Foo7: To queue To enable/disable PlantUML, update `hugo.toml`/`hugo.yaml`/`hugo.json`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.plantuml] @@ -500,7 +500,7 @@ params: Other optional settings are: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.plantuml] @@ -609,7 +609,7 @@ Automatically renders to: To enable/disable MarkMap, update `hugo.toml`/`hugo.yaml`/`hugo.json`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.markmap] @@ -650,7 +650,7 @@ As the diagram data is transported via the browser, the diagrams.net server does To enable detection of diagrams, update `hugo.toml`/`hugo.yaml`/`hugo.json`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.drawio] @@ -674,7 +674,7 @@ params: You can also [deploy and use your own server](https://github.com/jgraph/docker-drawio/blob/master/README.md) for editing diagrams, in which case update the configuration to point to that server: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.drawio] diff --git a/userguide/content/en/docs/adding-content/feedback.md b/userguide/content/en/docs/adding-content/feedback.md index a14cf7daab..c6c401c9b3 100644 --- a/userguide/content/en/docs/adding-content/feedback.md +++ b/userguide/content/en/docs/adding-content/feedback.md @@ -38,7 +38,7 @@ _requires_ `gtag.js`) and Universal Analytics (UA) site tags. If you prefer usin the older `analytics.js` library for your UA site tag, then set `params.disableGtagForUniversalAnalytics` to `true` in your project's [configuration file]. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params] @@ -136,7 +136,7 @@ other words! 2. Ensure that Google Analytics is enabled, as described [above](#setup). 3. Set the response text that users see after clicking **Yes** or **No**. - {{< tabpane persistLang=false >}} + {{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} @@ -219,7 +219,7 @@ response text. Add the parameter `hide_feedback` to the page's front matter and set it to `true`. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -243,7 +243,7 @@ hide_feedback: true Set `params.ui.feedback.enable` to `false` in `hugo.toml`/`hugo.yaml`/`hugo.json`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.ui.feedback] diff --git a/userguide/content/en/docs/adding-content/iconsimages.md b/userguide/content/en/docs/adding-content/iconsimages.md index 94fc43b7da..29dcdcd2d5 100644 --- a/userguide/content/en/docs/adding-content/iconsimages.md +++ b/userguide/content/en/docs/adding-content/iconsimages.md @@ -14,7 +14,7 @@ overrides the default Docsy logo in the theme. If you don't want a logo to appear in the navbar, then set `navbar_logo` to `false` in your project's config: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} navbar_logo = false diff --git a/userguide/content/en/docs/adding-content/lookandfeel.md b/userguide/content/en/docs/adding-content/lookandfeel.md index eeffcca1cb..e64509ab03 100644 --- a/userguide/content/en/docs/adding-content/lookandfeel.md +++ b/userguide/content/en/docs/adding-content/lookandfeel.md @@ -93,7 +93,7 @@ When you use `.-bg-`, the text colors will be adjusted to get proper cont 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 `hugo.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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [markup] @@ -130,7 +130,7 @@ markup: 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} # Uncomment if you want your chosen highlight style used for code blocks without a specified language @@ -155,7 +155,7 @@ You can find out more about code highlighting in Hugo with Chroma in [Syntax Hig Optionally, you can enable Prism syntax highlighting in your `hugo.toml`/`hugo.yaml`/`hugo.json`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} # Enable syntax highlighting and copy buttons on code blocks with Prism diff --git a/userguide/content/en/docs/adding-content/navigation.md b/userguide/content/en/docs/adding-content/navigation.md index 42ea40033f..7b5c1d49d0 100644 --- a/userguide/content/en/docs/adding-content/navigation.md +++ b/userguide/content/en/docs/adding-content/navigation.md @@ -11,7 +11,7 @@ The top level menu (the one that appears in the top navigation bar for the entir 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 >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -51,7 +51,7 @@ The menu is ordered from left to right by page `weight`. So, for example, a sect 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [[menu.main]] @@ -85,7 +85,7 @@ 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [[menu.main]] @@ -142,7 +142,7 @@ You can find out more in [Multi-language support](/docs/language/). The section menu, as shown in the left side of the `docs` section, is automatically built from the `content` tree. Like the top-level menu, it is ordered by page or section index `weight` (or by page creation `date` if `weight` is not set), with the page or index's `Title`, or `linkTitle` if different, as its link title in the menu. If a section subfolder has pages other than `_index.md` or `_index.html`, those pages will appear as a submenu, again ordered by `weight`. For example, here's the metadata for this page showing its `weight` and `title`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -180,7 +180,7 @@ To hide a page or section from the left navigation menu, set `toc_hide: true` in To hide a page from the section summary on a [docs section landing page]({{< ref "content#docs-section-landing-pages" >}}), set `hide_summary: true` in the front matter. If you want to hide a page from both the TOC menu and the section summary list, you need to set both `toc_hide` and `hide_summary` to `true` in the front matter. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -226,7 +226,7 @@ On large sites (default: > 2000 pages) the section menu is not generated for eac The tabbed pane below lists the menu section options you can define in your project [configuration file]. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}}{{< tab header="hugo.toml" lang="toml" >}} [params.ui] sidebar_menu_compact = true @@ -285,7 +285,7 @@ Breadcrumb navigation links are also shown for each item on the taxonomy results The tabbed pane below lists the breadcrumb navigation options you can define in your project [configuration file]. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}}{{< tab header="hugo.toml" lang="toml" >}} [params.ui] breadcrumb_disable = true @@ -325,7 +325,7 @@ Be aware that if you accidentally enable more than one search option in your pro 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} sidebar_search_disable = true @@ -360,7 +360,7 @@ Once you have your search engine set up, you can add the feature to your site: 1. Ensure you have a Markdown file in `content/en/search.md` (and one per other languages if needed) to display your search results. It only needs a title and `layout: search`, as in the following example: - {{< tabpane persistLang=false >}} + {{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -384,7 +384,7 @@ layout: search 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 >}} + {{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} gcs_engine_id = "011737558837375720776:fsdu1nryfng" @@ -422,7 +422,7 @@ If you are accepted to the program, you will receive the code to add to your doc 1. Enable Algolia DocSearch in `hugo.toml`/`hugo.yaml`/`hugo.json`. - {{< tabpane persistLang=false >}} + {{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} algolia_docsearch = true @@ -474,7 +474,7 @@ To add Lunr search to your Docsy site: 1. Enable local search in `hugo.toml`/`hugo.yaml`/`hugo.json`. - {{< tabpane persistLang=false >}} + {{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} offlineSearch = true @@ -501,7 +501,7 @@ If you're [testing this locally](/docs/deployment/#serving-your-site-locally) us You can customize the summary length by setting `offlineSearchSummaryLength` in `hugo.toml`/`hugo.yaml`/`hugo.json`. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} #Enable offline search with Lunr.js @@ -524,7 +524,7 @@ offlineSearchSummaryLength: 200 You can customize the maximum result count by setting `offlineSearchMaxResults` in `hugo.toml`/`hugo.yaml`/`hugo.json`. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} offlineSearch = true @@ -558,7 +558,7 @@ If you want to limit the width, add the following scss into `assets/scss/_variab To exclude pages from local search results, add `exclude_search: true` to the the frontmatter of each page: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ diff --git a/userguide/content/en/docs/adding-content/print.md b/userguide/content/en/docs/adding-content/print.md index b17113aa32..101d84a48f 100644 --- a/userguide/content/en/docs/adding-content/print.md +++ b/userguide/content/en/docs/adding-content/print.md @@ -12,7 +12,7 @@ On some sites, it can be useful to enable a "print entire section" feature (as s 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [outputs] @@ -46,7 +46,7 @@ The site should then show a "Print entire section" link in the right hand naviga 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 >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ diff --git a/userguide/content/en/docs/adding-content/repository-links.md b/userguide/content/en/docs/adding-content/repository-links.md index 151ec9d1b2..685114ed67 100644 --- a/userguide/content/en/docs/adding-content/repository-links.md +++ b/userguide/content/en/docs/adding-content/repository-links.md @@ -24,7 +24,7 @@ There are four variables you can configure in `hugo.toml`/`hugo.yaml`/`hugo.json The URL for your site's source repository. This is used to generate the **Edit this page**, **Create child page**, and **Create documentation issue** links. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} github_repo = "https://github.com/google/docsy" @@ -43,7 +43,7 @@ github_repo: 'https://github.com/google/docsy' Specify a value here if your content directory is not in your repo's root directory. For example, this site is in the `userguide` subdirectory of its repo. Setting this value means that your edit links will go to the right page. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} github_subdir = "userguide" @@ -62,7 +62,7 @@ github_subdir: 'userguide' Specify a value here if you have a separate project repo and you'd like your users to be able to create issues against your project from the relevant docs. The **Create project issue** link appears only if this is set. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} github_project_repo = "https://github.com/google/docsy" @@ -81,7 +81,7 @@ github_project_repo: 'https://github.com/google/docsy' Specify a value here if you have would like to reference a different branch for the other github settings like **Edit this page** or **Create project issue**. -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} github_branch = "release" @@ -103,7 +103,7 @@ come from another repo, such as a [git submodule][]. Add settings like these to the **section's index page** so that the repository links for all pages in that section refer to the originating repo: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -163,7 +163,7 @@ cascade: --- ``` -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -200,7 +200,7 @@ Please note that the YAML code fragment makes use of [Yaml anchor](https://suppo The `path_base_for_github_subdir` setting is a regular expression, so you can use it even if you have a site with [multiple languages][] for example: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -229,7 +229,7 @@ In situations where a page originates from a file under a different name, you can specify `from` and `to` path-rename settings. Here's an example where an index file is named `README.md` in the originating repo: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -278,7 +278,7 @@ path_base_for_github_subdir: Specify a value for this **in your page metadata** to set a specific edit URL for this page, as in the following example: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ diff --git a/userguide/content/en/docs/adding-content/shortcodes/index.md b/userguide/content/en/docs/adding-content/shortcodes/index.md index ee14e5c3d1..15993cb3e6 100644 --- a/userguide/content/en/docs/adding-content/shortcodes/index.md +++ b/userguide/content/en/docs/adding-content/shortcodes/index.md @@ -207,7 +207,7 @@ Norway Spruce *Picea abies* shoot with foliage buds. The example above has also a byline with photo attribution added. When using illustrations with a free license from [WikiMedia](https://commons.wikimedia.org/) and similar, you will in most situations need a way to attribute the author or licensor. You can add metadata to your page resources in the page front matter. The `byline` param is used by convention in this theme: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ @@ -250,7 +250,7 @@ resources: The `swaggerui` shortcode can be placed anywhere inside a page with the [`swagger` layout](https://github.com/google/docsy/tree/main/layouts/swagger); it renders [Swagger UI](https://swagger.io/tools/swagger-ui/) using any OpenAPI YAML or JSON file as source. This file can be hosted anywhere you like, for example in your site's root [`/static` folder](/docs/adding-content/content/#adding-static-content). -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Front matter:" disabled=true />}} {{< tab header="toml" lang="toml" >}} +++ diff --git a/userguide/content/en/docs/adding-content/taxonomy.md b/userguide/content/en/docs/adding-content/taxonomy.md index 82968951aa..dd9e086419 100644 --- a/userguide/content/en/docs/adding-content/taxonomy.md +++ b/userguide/content/en/docs/adding-content/taxonomy.md @@ -31,7 +31,7 @@ There are various parameter to control the functionality of taxonomies in the pr 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} disableKinds = ["taxonomy", "taxonomyTerm"] @@ -55,7 +55,7 @@ If you want to enable taxonomies in Docsy you have to delete (or comment out) th With the following example you define a additional taxonomy `projects` beside the default taxonomies `tags` and `categories`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [taxonomies] @@ -82,7 +82,7 @@ taxonomies: 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [params.taxonomy] diff --git a/userguide/content/en/docs/adding-content/versioning.md b/userguide/content/en/docs/adding-content/versioning.md index ade8ad11b5..58c91d0c84 100644 --- a/userguide/content/en/docs/adding-content/versioning.md +++ b/userguide/content/en/docs/adding-content/versioning.md @@ -18,7 +18,7 @@ If you add some `[params.versions]` in `hugo.toml`/`hugo.yaml`/`hugo.json`, the 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 >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} # Add your release versions here @@ -71,7 +71,7 @@ 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 `hugo.toml`/`hugo.yaml`/`hugo.json`: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} version_menu = "Releases" @@ -115,7 +115,7 @@ To add the banner to your doc site, make the following changes in your 1. Set the `archived_version` parameter to `true`: - {{< tabpane persistLang=false >}} + {{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} archived_version = true @@ -131,7 +131,7 @@ archived_version: true 1. Set the `version` parameter to the version of the archived doc set. For example, if the archived docs are for version 0.1: - {{< tabpane persistLang=false >}} + {{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} version = "0.1" @@ -148,7 +148,7 @@ version: '0.1' want to point readers to. In most cases, this should be the URL of the latest version of your docs: - {{< tabpane persistLang=false >}} + {{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} url_latest_version = "https://your-latest-doc-site.com" diff --git a/userguide/content/en/docs/deployment/_index.md b/userguide/content/en/docs/deployment/_index.md index f8aea89080..c2c36129c5 100644 --- a/userguide/content/en/docs/deployment/_index.md +++ b/userguide/content/en/docs/deployment/_index.md @@ -42,7 +42,7 @@ Then follow the instructions in [Host on Netlify](https://gohugo.io/hosting-and- 1. In the **Deploy settings** page: 1. Specify your **Build command**. The exact build command depends on how you have chosen to use Docsy: * If you are using Docsy as a [Git submodule](/docs/get-started/other-options/#option-1-docsy-as-a-git-submodule), specify `cd themes/docsy && git submodule update -f --init && cd ../.. && hugo`. You need to specify this rather than just `hugo` so that Netlify can use the theme's submodules. - * If you are using Docsy as a [Hugo module](/docs/get-started/docsy-as-module/) or NPM package, you can just specify `hugo`. + * If you are using Docsy as a [Hugo module](/docs/get-started/docsy-as-module/) or NPM package, you can just specify `hugo`. 3. Click **Show advanced**. 4. In the **Advanced build settings** section, click **New variable**. 5. Specify `HUGO_VERSION` as the **Key** for the new variable, and set its **Value** to the latest version of Hugo (minimum required version: `0.110.0`). @@ -90,7 +90,7 @@ There are several options for publishing your web site using [Amazon Web Service 1. Inside your `hugo.toml`/`hugo.yaml`/`hugo.json`, add a `[deployment]` section like this one: - {{< tabpane persistLang=false >}} + {{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} [deployment] diff --git a/userguide/content/en/docs/language/_index.md b/userguide/content/en/docs/language/_index.md index e6f5907634..eed56a6c61 100644 --- a/userguide/content/en/docs/language/_index.md +++ b/userguide/content/en/docs/language/_index.md @@ -12,7 +12,7 @@ If you'd like to provide site content in multiple languages, the Docsy theme and To add content in multiple languages, you first need to define the available languages in a `languages` section in your site configuration. Each language can have its own language-specific configuration. For example, the Docsy Example Site config specifies that it provides content in English and Norwegian, and that the language version visitors will see by default is English: -{{< tabpane persistLang=false >}} +{{< tabpane >}} {{< tab header="Configuration file:" disabled=true />}} {{< tab header="hugo.toml" lang="toml" >}} contentDir = "content/en"