diff --git a/layouts/partials/breadcrumb.html b/layouts/_partials/breadcrumb.html similarity index 100% rename from layouts/partials/breadcrumb.html rename to layouts/_partials/breadcrumb.html diff --git a/layouts/partials/community_links.html b/layouts/_partials/community_links.html similarity index 100% rename from layouts/partials/community_links.html rename to layouts/_partials/community_links.html diff --git a/layouts/partials/disqus-comment.html b/layouts/_partials/disqus-comment.html similarity index 100% rename from layouts/partials/disqus-comment.html rename to layouts/_partials/disqus-comment.html diff --git a/layouts/partials/favicons.html b/layouts/_partials/favicons.html similarity index 100% rename from layouts/partials/favicons.html rename to layouts/_partials/favicons.html diff --git a/layouts/partials/featured-image.html b/layouts/_partials/featured-image.html similarity index 100% rename from layouts/partials/featured-image.html rename to layouts/_partials/featured-image.html diff --git a/layouts/partials/feedback.html b/layouts/_partials/feedback.html similarity index 100% rename from layouts/partials/feedback.html rename to layouts/_partials/feedback.html diff --git a/layouts/partials/footer.html b/layouts/_partials/footer.html similarity index 100% rename from layouts/partials/footer.html rename to layouts/_partials/footer.html diff --git a/layouts/partials/footer/center.html b/layouts/_partials/footer/center.html similarity index 100% rename from layouts/partials/footer/center.html rename to layouts/_partials/footer/center.html diff --git a/layouts/partials/footer/copyright.html b/layouts/_partials/footer/copyright.html similarity index 100% rename from layouts/partials/footer/copyright.html rename to layouts/_partials/footer/copyright.html diff --git a/layouts/partials/footer/left.html b/layouts/_partials/footer/left.html similarity index 100% rename from layouts/partials/footer/left.html rename to layouts/_partials/footer/left.html diff --git a/layouts/partials/footer/links.html b/layouts/_partials/footer/links.html similarity index 100% rename from layouts/partials/footer/links.html rename to layouts/_partials/footer/links.html diff --git a/layouts/partials/footer/right.html b/layouts/_partials/footer/right.html similarity index 100% rename from layouts/partials/footer/right.html rename to layouts/_partials/footer/right.html diff --git a/layouts/partials/head-css.html b/layouts/_partials/head-css.html similarity index 100% rename from layouts/partials/head-css.html rename to layouts/_partials/head-css.html diff --git a/layouts/partials/head.html b/layouts/_partials/head.html similarity index 100% rename from layouts/partials/head.html rename to layouts/_partials/head.html diff --git a/layouts/partials/hooks/body-end.html b/layouts/_partials/hooks/body-end.html similarity index 100% rename from layouts/partials/hooks/body-end.html rename to layouts/_partials/hooks/body-end.html diff --git a/layouts/partials/hooks/head-end.html b/layouts/_partials/hooks/head-end.html similarity index 100% rename from layouts/partials/hooks/head-end.html rename to layouts/_partials/hooks/head-end.html diff --git a/layouts/partials/navbar-lang-selector.html b/layouts/_partials/navbar-lang-selector.html similarity index 100% rename from layouts/partials/navbar-lang-selector.html rename to layouts/_partials/navbar-lang-selector.html diff --git a/layouts/partials/navbar-version-selector.html b/layouts/_partials/navbar-version-selector.html similarity index 100% rename from layouts/partials/navbar-version-selector.html rename to layouts/_partials/navbar-version-selector.html diff --git a/layouts/partials/navbar.html b/layouts/_partials/navbar.html similarity index 100% rename from layouts/partials/navbar.html rename to layouts/_partials/navbar.html diff --git a/layouts/partials/outputformat.html b/layouts/_partials/outputformat.html similarity index 100% rename from layouts/partials/outputformat.html rename to layouts/_partials/outputformat.html diff --git a/layouts/partials/page-description.html b/layouts/_partials/page-description.html similarity index 100% rename from layouts/partials/page-description.html rename to layouts/_partials/page-description.html diff --git a/layouts/partials/page-meta-lastmod.html b/layouts/_partials/page-meta-lastmod.html similarity index 100% rename from layouts/partials/page-meta-lastmod.html rename to layouts/_partials/page-meta-lastmod.html diff --git a/layouts/partials/page-meta-links.html b/layouts/_partials/page-meta-links.html similarity index 100% rename from layouts/partials/page-meta-links.html rename to layouts/_partials/page-meta-links.html diff --git a/layouts/partials/pager.html b/layouts/_partials/pager.html similarity index 100% rename from layouts/partials/pager.html rename to layouts/_partials/pager.html diff --git a/layouts/partials/print/content-blog.html b/layouts/_partials/print/content-blog.html similarity index 100% rename from layouts/partials/print/content-blog.html rename to layouts/_partials/print/content-blog.html diff --git a/layouts/partials/print/content.html b/layouts/_partials/print/content.html similarity index 89% rename from layouts/partials/print/content.html rename to layouts/_partials/print/content.html index 5e42cd1831..ae5711f2da 100644 --- a/layouts/partials/print/content.html +++ b/layouts/_partials/print/content.html @@ -1,6 +1,6 @@ {{ $tpl := printf "print/content-%s.html" .Page.Type }} -{{ if templates.Exists (printf "partials/%s" $tpl) }} +{{ if templates.Exists (printf "_partials/%s" $tpl) }} {{ partial $tpl . }} {{ else -}} {{ $break := cond .DoPageBreak "page-break-before: always" "" -}} diff --git a/layouts/partials/print/page-heading.html b/layouts/_partials/print/page-heading.html similarity index 85% rename from layouts/partials/print/page-heading.html rename to layouts/_partials/print/page-heading.html index a0a2d63111..ad2e88039b 100644 --- a/layouts/partials/print/page-heading.html +++ b/layouts/_partials/print/page-heading.html @@ -1,7 +1,7 @@ {{/* Use the title and description of the first page to begin the document */}} {{ $tpl := printf "print/page-heading-%s.html" .Page.Type }} -{{ if templates.Exists (printf "partials/%s" $tpl) }} +{{ if templates.Exists (printf "_partials/%s" $tpl) }} {{ partial $tpl . }} {{ else -}}

{{ .Title }}

diff --git a/layouts/partials/print/render.html b/layouts/_partials/print/render.html similarity index 100% rename from layouts/partials/print/render.html rename to layouts/_partials/print/render.html diff --git a/layouts/partials/print/toc-li-blog.html b/layouts/_partials/print/toc-li-blog.html similarity index 100% rename from layouts/partials/print/toc-li-blog.html rename to layouts/_partials/print/toc-li-blog.html diff --git a/layouts/partials/print/toc-li.html b/layouts/_partials/print/toc-li.html similarity index 76% rename from layouts/partials/print/toc-li.html rename to layouts/_partials/print/toc-li.html index 27fbb5e445..8606f41f84 100644 --- a/layouts/partials/print/toc-li.html +++ b/layouts/_partials/print/toc-li.html @@ -1,5 +1,5 @@ {{ $tpl := printf "print/toc-li-%s.html" .Page.Type }} -{{ if templates.Exists (printf "partials/%s" $tpl) }} +{{ if templates.Exists (printf "_partials/%s" $tpl) }} {{ partial $tpl . }} {{ else -}}
  • {{ .sid}}: {{ .Page.Title }}
    • diff --git a/layouts/partials/reading-time.html b/layouts/_partials/reading-time.html similarity index 100% rename from layouts/partials/reading-time.html rename to layouts/_partials/reading-time.html diff --git a/layouts/partials/scripts.html b/layouts/_partials/scripts.html similarity index 100% rename from layouts/partials/scripts.html rename to layouts/_partials/scripts.html diff --git a/layouts/partials/scripts/mermaid.html b/layouts/_partials/scripts/mermaid.html similarity index 100% rename from layouts/partials/scripts/mermaid.html rename to layouts/_partials/scripts/mermaid.html diff --git a/layouts/partials/search-input.html b/layouts/_partials/search-input.html similarity index 100% rename from layouts/partials/search-input.html rename to layouts/_partials/search-input.html diff --git a/layouts/partials/section-index.html b/layouts/_partials/section-index.html similarity index 100% rename from layouts/partials/section-index.html rename to layouts/_partials/section-index.html diff --git a/layouts/partials/sidebar-tree.html b/layouts/_partials/sidebar-tree.html similarity index 100% rename from layouts/partials/sidebar-tree.html rename to layouts/_partials/sidebar-tree.html diff --git a/layouts/partials/sidebar.html b/layouts/_partials/sidebar.html similarity index 100% rename from layouts/partials/sidebar.html rename to layouts/_partials/sidebar.html diff --git a/layouts/partials/taxonomy_terms_article.html b/layouts/_partials/taxonomy_terms_article.html similarity index 100% rename from layouts/partials/taxonomy_terms_article.html rename to layouts/_partials/taxonomy_terms_article.html diff --git a/layouts/partials/taxonomy_terms_article_wrapper.html b/layouts/_partials/taxonomy_terms_article_wrapper.html similarity index 100% rename from layouts/partials/taxonomy_terms_article_wrapper.html rename to layouts/_partials/taxonomy_terms_article_wrapper.html diff --git a/layouts/partials/taxonomy_terms_cloud.html b/layouts/_partials/taxonomy_terms_cloud.html similarity index 100% rename from layouts/partials/taxonomy_terms_cloud.html rename to layouts/_partials/taxonomy_terms_cloud.html diff --git a/layouts/partials/taxonomy_terms_clouds.html b/layouts/_partials/taxonomy_terms_clouds.html similarity index 100% rename from layouts/partials/taxonomy_terms_clouds.html rename to layouts/_partials/taxonomy_terms_clouds.html diff --git a/layouts/partials/td/render-heading.html b/layouts/_partials/td/render-heading.html similarity index 86% rename from layouts/partials/td/render-heading.html rename to layouts/_partials/td/render-heading.html index 898b8f5dd9..bbb9942a81 100644 --- a/layouts/partials/td/render-heading.html +++ b/layouts/_partials/td/render-heading.html @@ -7,6 +7,6 @@ {{ partial "td/heading-self-link.html" . -}} -{{- define "partials/td/heading-self-link.html" -}} +{{- define "_partials/td/heading-self-link.html" -}} {{- end -}} diff --git a/layouts/partials/theme-toggler.html b/layouts/_partials/theme-toggler.html similarity index 100% rename from layouts/partials/theme-toggler.html rename to layouts/_partials/theme-toggler.html diff --git a/layouts/partials/toc.html b/layouts/_partials/toc.html similarity index 100% rename from layouts/partials/toc.html rename to layouts/_partials/toc.html diff --git a/layouts/partials/version-banner.html b/layouts/_partials/version-banner.html similarity index 100% rename from layouts/partials/version-banner.html rename to layouts/_partials/version-banner.html diff --git a/layouts/shortcodes/alert.html b/layouts/_shortcodes/alert.html similarity index 100% rename from layouts/shortcodes/alert.html rename to layouts/_shortcodes/alert.html diff --git a/layouts/shortcodes/blocks/cover.html b/layouts/_shortcodes/blocks/cover.html similarity index 100% rename from layouts/shortcodes/blocks/cover.html rename to layouts/_shortcodes/blocks/cover.html diff --git a/layouts/shortcodes/blocks/feature.html b/layouts/_shortcodes/blocks/feature.html similarity index 100% rename from layouts/shortcodes/blocks/feature.html rename to layouts/_shortcodes/blocks/feature.html diff --git a/layouts/shortcodes/blocks/lead.html b/layouts/_shortcodes/blocks/lead.html similarity index 100% rename from layouts/shortcodes/blocks/lead.html rename to layouts/_shortcodes/blocks/lead.html diff --git a/layouts/shortcodes/blocks/link-down.html b/layouts/_shortcodes/blocks/link-down.html similarity index 100% rename from layouts/shortcodes/blocks/link-down.html rename to layouts/_shortcodes/blocks/link-down.html diff --git a/layouts/shortcodes/blocks/section.html b/layouts/_shortcodes/blocks/section.html similarity index 100% rename from layouts/shortcodes/blocks/section.html rename to layouts/_shortcodes/blocks/section.html diff --git a/layouts/shortcodes/card.html b/layouts/_shortcodes/card.html similarity index 100% rename from layouts/shortcodes/card.html rename to layouts/_shortcodes/card.html diff --git a/layouts/shortcodes/cardpane.html b/layouts/_shortcodes/cardpane.html similarity index 100% rename from layouts/shortcodes/cardpane.html rename to layouts/_shortcodes/cardpane.html diff --git a/layouts/shortcodes/comment.html b/layouts/_shortcodes/comment.html similarity index 100% rename from layouts/shortcodes/comment.html rename to layouts/_shortcodes/comment.html diff --git a/layouts/shortcodes/conditional-text.html b/layouts/_shortcodes/conditional-text.html similarity index 100% rename from layouts/shortcodes/conditional-text.html rename to layouts/_shortcodes/conditional-text.html diff --git a/layouts/shortcodes/iframe.html b/layouts/_shortcodes/iframe.html similarity index 100% rename from layouts/shortcodes/iframe.html rename to layouts/_shortcodes/iframe.html diff --git a/layouts/shortcodes/imgproc.html b/layouts/_shortcodes/imgproc.html similarity index 100% rename from layouts/shortcodes/imgproc.html rename to layouts/_shortcodes/imgproc.html diff --git a/layouts/shortcodes/pageinfo.html b/layouts/_shortcodes/pageinfo.html similarity index 100% rename from layouts/shortcodes/pageinfo.html rename to layouts/_shortcodes/pageinfo.html diff --git a/layouts/shortcodes/readfile.html b/layouts/_shortcodes/readfile.html similarity index 100% rename from layouts/shortcodes/readfile.html rename to layouts/_shortcodes/readfile.html diff --git a/layouts/shortcodes/redoc.html b/layouts/_shortcodes/redoc.html similarity index 100% rename from layouts/shortcodes/redoc.html rename to layouts/_shortcodes/redoc.html diff --git a/layouts/shortcodes/swaggerui.html b/layouts/_shortcodes/swaggerui.html similarity index 100% rename from layouts/shortcodes/swaggerui.html rename to layouts/_shortcodes/swaggerui.html diff --git a/layouts/shortcodes/tab.html b/layouts/_shortcodes/tab.html similarity index 100% rename from layouts/shortcodes/tab.html rename to layouts/_shortcodes/tab.html diff --git a/layouts/shortcodes/tabpane.html b/layouts/_shortcodes/tabpane.html similarity index 100% rename from layouts/shortcodes/tabpane.html rename to layouts/_shortcodes/tabpane.html diff --git a/userguide/content/en/docs/adding-content/feedback.md b/userguide/content/en/docs/adding-content/feedback.md index ae3cdb31bb..a91b32d5a6 100644 --- a/userguide/content/en/docs/adding-content/feedback.md +++ b/userguide/content/en/docs/adding-content/feedback.md @@ -294,8 +294,7 @@ using the first of the following that is defined: - For non-index pages, the page [summary][], as computed by Hugo - The site description taken from the [site `params`][] -For the template code used to perform this computation, see -[layouts/partials/page-description.html][]. +For the code used to perform this computation, see [page-description.html]. Add more meta tags as needed to your project's copy of the `head-end.html` partial. For details, see @@ -308,8 +307,8 @@ partial. For details, see [gtag.js]: https://support.google.com/analytics/answer/10220869 [hugo-ga]: https://gohugo.io/templates/internal/#google-analytics [internal templates]: https://gohugo.io/templates/internal/ -[layouts/partials/page-description.html]: - https://github.com/google/docsy/blob/main/layouts/partials/page-description.html +[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 diff --git a/userguide/content/en/docs/adding-content/iconsimages.md b/userguide/content/en/docs/adding-content/iconsimages.md index 3d7fb10e8c..d7a0f919f6 100644 --- a/userguide/content/en/docs/adding-content/iconsimages.md +++ b/userguide/content/en/docs/adding-content/iconsimages.md @@ -74,7 +74,7 @@ favicons you can use this site to generate them, then use Icongen to create more sizes (if necessary) from your generated `.png` file. If you have special favicon requirements, you can create your own -`layouts/partials/favicons.html` with your links. +`layouts/_partials/favicons.html` with your links. ## Add images diff --git a/userguide/content/en/docs/adding-content/lookandfeel.md b/userguide/content/en/docs/adding-content/lookandfeel.md index 669260da5f..42a6b21589 100644 --- a/userguide/content/en/docs/adding-content/lookandfeel.md +++ b/userguide/content/en/docs/adding-content/lookandfeel.md @@ -484,28 +484,22 @@ this: ### Add code to head or before body end If you need to add some code (CSS import, cookie consent, or similar) to the -`head` section on every page, add the `head-end.html` partial to your project: - -``` -layouts/partials/hooks/head-end.html -``` - -And add the code you need in that file. Your partial code is automatically -included just before the end of the theme partial -[`head.html`](https://github.com/google/docsy/blob/main/layouts/partials/head.html). -The theme version of -[`head-end.html`](https://github.com/google/docsy/blob/main/layouts/partials/hooks/head-end.html) -is empty. +`head` section on every page, add a [hooks/head-end.html] partial to your +project (the theme version is an empty placeholder). The content of this partial +is automatically included just before the end of the theme partial [head.html]. Similarly, if you want to add some code right before the `body` end, create your -own version of the following file: - -``` -layouts/partials/hooks/body-end.html -``` - -Any code in this file is included automatically at the end of the theme partial -[`scripts.html`](https://github.com/google/docsy/blob/main/layouts/partials/head.html). +own version of [hooks/body-end.html]. This partial is included automatically at +the end of the theme partial [scripts.html]. + +[head.html]: + https://github.com/google/docsy/blob/main/layouts/_partials/head.html +[hooks/body-end.html]: + https://github.com/google/docsy/blob/main/layouts/_partials/hooks/body-end.html +[hooks/head-end.html]: + https://github.com/google/docsy/blob/main/layouts/_partials/hooks/head-end.html +[scripts.html]: + https://github.com/google/docsy/blob/main/layouts/_partials/head.html Both `head.html` and `scripts.html` are then used to build Docsy's [base page layout](https://github.com/google/docsy/blob/main/layouts/_default/baseof.html), diff --git a/userguide/content/en/docs/adding-content/navigation.md b/userguide/content/en/docs/adding-content/navigation.md index 64f284b6d4..cda7ea0f53 100644 --- a/userguide/content/en/docs/adding-content/navigation.md +++ b/userguide/content/en/docs/adding-content/navigation.md @@ -459,10 +459,10 @@ defaults: Your projects can also reuse (in your own custom heading render hook) or override the heading self-link partial `td/heading-self-link.html`, which is -defined in [layouts/partials/td/render-heading.html]. +defined in [layouts/_partials/td/render-heading.html]. [configuration file]: https://gohugo.io/getting-started/configuration/#configuration-file -[layouts/partials/td/render-heading.html]: - https://github.com/google/docsy/tree/main/layouts/partials/td/render-heading.html +[layouts/_partials/td/render-heading.html]: + https://github.com/google/docsy/tree/main/layouts/_partials/td/render-heading.html [hook]: https://gohugo.io/templates/render-hooks/ diff --git a/userguide/content/en/docs/adding-content/print.md b/userguide/content/en/docs/adding-content/print.md index 22cd47531b..1fdb45339d 100644 --- a/userguide/content/en/docs/adding-content/print.md +++ b/userguide/content/en/docs/adding-content/print.md @@ -111,13 +111,13 @@ params: ## Layout hooks A number of layout partials and hooks are defined that can be used to customize -the printed format. These can be found in `layouts/partials/print`. +the printed format. These can be found in `layouts/_partials/print`. Hooks can be defined on a per-type basis. For example, you may want to customize the layouts of heading for "blog" pages vs "docs". This can be achieved by -creating `layouts/partials/print/page-heading-.html` - eg. +creating `layouts/_partials/print/page-heading-.html` such as `page-heading-blog.html`. It defaults to using the page title and description as a heading. Similarly, the formatting for each page can be customized by creating -`layouts/partials/print/content-.html`. +`layouts/_partials/print/content-.html`. diff --git a/userguide/content/en/docs/adding-content/search.md b/userguide/content/en/docs/adding-content/search.md index 6075ab73a1..7272d8b8d6 100644 --- a/userguide/content/en/docs/adding-content/search.md +++ b/userguide/content/en/docs/adding-content/search.md @@ -244,10 +244,10 @@ search results page. You can customize or disable Docsy's default Algolia support by creating the following template files: -- `layouts/partials/algolia/head.html` used by `head.html` to load Algolia +- `layouts/_partials/algolia/head.html` used by `head.html` to load Algolia DocSearch styles. It also issues a deprecation warning for `params.algolia_docsearch`. -- `layouts/partials/algolia/scripts.html` used by `scripts.html` to load and +- `layouts/_partials/algolia/scripts.html` used by `scripts.html` to load and configure Algolia DocSearch. Leave either file empty to disable Docsy's implementation. @@ -414,7 +414,7 @@ If none of the supported search engines address your project's needs, you can implement your own custom search. If your searchbox fits within Docsy's standard design, then you can implement custom search by overriding the following files: -- [layouts/partials/search-input.html] +- [layouts/_partials/search-input.html] - [assets/scss/_search.scss] - [assets/js/search.js] @@ -426,5 +426,5 @@ design, then you can implement custom search by overriding the following files: [configuration file]: https://gohugo.io/getting-started/configuration/#configuration-file [GCSE]: https://cse.google.com/cse/all -[layouts/partials/search-input.html]: - https://github.com/google/docsy/blob/main/layouts/partials/search-input.html +[layouts/_partials/search-input.html]: + https://github.com/google/docsy/blob/main/layouts/_partials/search-input.html