diff --git a/CHANGELOG.md b/CHANGELOG.md index e5708b97da..325d37b7e5 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -42,11 +42,12 @@ For the full list of changes, see the [0.x.y] release notes. - **[Breadcrumb navigation]** support has been enhanced and adjusted: - You can now disable breadcrumbs for an entire project, or individual pages or sections by setting `ui.breadcrumb_disable` to true. For details, see - [Breadcrumb navigation]. + [Breadcrumb navigation][]. - **Blog** pages now also have breadcrumbs by default ([#1788]). - Index-page single-element breadcrumb lists are hidden by default ([#2160]). -- Support for a [td-content-after-header.html] page-content render hook, which - can be [content type] specific ([#2192]). +- Support for a [td/content-after-header.html] page-content render hook, which + can be [content type][] specific ([#2192]). For details, see the [User + Guide][before-page-content]. **Other changes**: @@ -63,13 +64,15 @@ For the full list of changes, see the [0.x.y] release notes. [#2192]: https://github.com/google/docsy/pull/2192 [#2223]: https://github.com/google/docsy/pull/2223 [#2243]: https://github.com/google/docsy/pull/2243 +[before-page-content]: + https://www.docsy.dev/docs/adding-content/lookandfeel/#before-page-content [Breadcrumb navigation]: https://www.docsy.dev/docs/adding-content/navigation/#breadcrumb-navigation [content type]: https://gohugo.io/quick-reference/glossary/#content-type [Heading self links]: https://www.docsy.dev/docs/adding-content/navigation/#heading-self-links -[td-content-after-header.html]: - https://github.com/google/docsy/blob/main/layouts/td-content-after-header.html +[td/content-after-header.html]: + https://github.com/google/docsy/blob/main/layouts/_partials/td/content-after-header.html ## 0.11.0 diff --git a/layouts/td-content-after-header.html b/layouts/_partials/td/content-after-header.html similarity index 100% rename from layouts/td-content-after-header.html rename to layouts/_partials/td/content-after-header.html diff --git a/layouts/blog/content.html b/layouts/blog/content.html index 5021da5101..2640f30e50 100644 --- a/layouts/blog/content.html +++ b/layouts/blog/content.html @@ -11,7 +11,7 @@

{{ .Title }}

{{ partial "reading-time.html" . -}} {{ end -}} - {{ .Render "td-content-after-header" -}} + {{ partial "td/content-after-header" . -}} {{ .Content }} {{ if (.Site.Config.Services.Disqus.Shortname) -}}
diff --git a/layouts/content.html b/layouts/content.html index 60d408612a..b8b11ef265 100644 --- a/layouts/content.html +++ b/layouts/content.html @@ -7,7 +7,7 @@

{{ .Title }}

{{ partial "reading-time.html" . -}} {{ end -}} - {{ .Render "td-content-after-header" -}} + {{ partial "td/content-after-header" . -}} {{ .Content }} {{ partial "feedback.html" . -}} {{ if (.Site.Config.Services.Disqus.Shortname) -}} diff --git a/layouts/docs/list.html b/layouts/docs/list.html index fbf840e47e..89ba284155 100644 --- a/layouts/docs/list.html +++ b/layouts/docs/list.html @@ -8,7 +8,7 @@

{{ .Title }}

{{ partial "reading-time.html" . -}} {{ end -}} - {{ .Render "td-content-after-header" -}} + {{ partial "td/content-after-header" . -}} {{ .Content }} {{ partial "section-index.html" . -}} {{ partial "feedback.html" . -}} diff --git a/userguide/.htmltest.yml b/userguide/.htmltest.yml index 760b30ce4c..5c25376847 100644 --- a/userguide/.htmltest.yml +++ b/userguide/.htmltest.yml @@ -23,5 +23,4 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored - ^https://badges.netlify.com/api - ^https://code.jquery.com # TEMPORARY until we're done with https://github.com/google/docsy/issues/2243 - - ^https://github.com/google/docsy/blob/main/layouts/td-content-after-header.html - - ^https://github.com/google/docsy/blob/main/layouts/baseof.html + - ^https://github.com/google/docsy/blob/main/layouts/_partials/td/content-after-header.html diff --git a/userguide/content/en/docs/adding-content/lookandfeel.md b/userguide/content/en/docs/adding-content/lookandfeel.md index 13174c2989..d193c38379 100644 --- a/userguide/content/en/docs/adding-content/lookandfeel.md +++ b/userguide/content/en/docs/adding-content/lookandfeel.md @@ -507,6 +507,16 @@ Both [head.html] and [scripts.html] are included from [baseof.html], Docsy's [scripts.html]: https://github.com/google/docsy/blob/main/layouts/_partials/head.html +### Adding a banner before page content (EXPERIMENTAL) {#before-page-content} + +To have a banner, or other similar content, appear at the top of the pages in a +section, add the content to the [td/content-after-header.html] partial. It will +appear inside the `div.td-content`, after ``, just before `.Content` is +rendered. + +[td/content-after-header.html]: + https://github.com/google/docsy/blob/main/layouts/_partials/td/content-after-header.html + ## Adding custom class to the body element By default, Docsy adds the `td-{{ .Kind }}` class, where the kind is the kind of diff --git a/userguide/package.json b/userguide/package.json index f48da88049..f9a4b269f6 100644 --- a/userguide/package.json +++ b/userguide/package.json @@ -8,6 +8,7 @@ "_commit:public": "HASH=$(git rev-parse --short main); cd public && git add -A && git commit -m \"Site at $HASH\"", "_hugo-dev": "npm run _hugo -- -e dev -DFE", "_hugo": "hugo --cleanDestinationDir --themesDir ../..", + "_refcache:prune": "jq 'with_entries(select(.value.StatusCode < 400))' static/refcache.json > tmp/refcache.json && mv tmp/refcache.json static/refcache.json", "_serve": "npm run _hugo-dev -- serve --minify --disableFastRender --renderToMemory", "build:preview": "npm run _hugo-dev -- --minify --baseURL \"${DEPLOY_PRIME_URL:-http://localhost}\"", "build:production": "npm run _hugo -- --minify", @@ -33,5 +34,5 @@ "postcss-cli": "^11.0.1", "rtlcss": "^4.3.0" }, - "cSpell:ignore": "- docsy htmltest pkgs postbuild precheck rtlcss -" + "cSpell:ignore": "- docsy htmltest pkgs postbuild precheck refcache rtlcss -" } diff --git a/userguide/static/refcache.json b/userguide/static/refcache.json index 1f9bfda6f7..0baa0e455c 100644 --- a/userguide/static/refcache.json +++ b/userguide/static/refcache.json @@ -727,6 +727,10 @@ "StatusCode": 206, "LastSeen": "2025-05-16T09:20:38.127906-04:00" }, + "https://github.com/google/docsy/blob/main/layouts/baseof.html": { + "StatusCode": 206, + "LastSeen": "2025-05-22T12:25:13.516369-04:00" + }, "https://github.com/google/docsy/blob/main/layouts/blog/baseof.html": { "StatusCode": 206, "LastSeen": "2025-05-16T09:20:42.383402-04:00" @@ -2303,6 +2307,10 @@ "StatusCode": 206, "LastSeen": "2024-11-06T12:06:01.765051-05:00" }, + "https://www.docsy.dev/docs/adding-content/lookandfeel/#before-page-content": { + "StatusCode": 206, + "LastSeen": "2025-05-22T13:24:36.066951-04:00" + }, "https://www.docsy.dev/docs/adding-content/lookandfeel/#code-highlighting-with-chroma": { "StatusCode": 206, "LastSeen": "2024-11-06T12:07:28.264639-05:00"