diff --git a/assets/stubs/new-page-template.md b/assets/stubs/new-page-template.md index 906ee7d8d1..43080c1c96 100644 --- a/assets/stubs/new-page-template.md +++ b/assets/stubs/new-page-template.md @@ -10,7 +10,7 @@ description: >- Edit this template to create your new page. -* Give it a good name, ending in `.md` - e.g. `getting-started.md` +* Give it a good name, ending in `.md` - e.g. `get-started.md` * Edit the "front matter" section at the top of the page (weight controls how its ordered amongst other pages in the same directory; lowest number first). * Add a good commit message at the bottom of the page (<80 characters; use the extended description field for more detail). * Create a new branch so you can preview your new file and request a review via Pull Request. diff --git a/docsy.dev/config/_default/params.yaml b/docsy.dev/config/_default/params.yaml index 9a6e3f40c5..91bddcb74f 100644 --- a/docsy.dev/config/_default/params.yaml +++ b/docsy.dev/config/_default/params.yaml @@ -7,7 +7,7 @@ # status: archived # Then fetch include version: &docsyVersion 0.14.3-dev -tdBuildId: 009-over-main-601fd46d +tdBuildId: 010-over-main-1aae2c92 versionLatest: &versionLatest v0.14.2 version_menu: *docsyVersion version_menu_pagelinks: true diff --git a/docsy.dev/config/doc-rooted/hugo.yaml b/docsy.dev/config/doc-rooted/hugo.yaml new file mode 100644 index 0000000000..5c4f106b9c --- /dev/null +++ b/docsy.dev/config/doc-rooted/hugo.yaml @@ -0,0 +1,7 @@ +# This doc-rooted variant of the Docsy site overrides the existing home page, +# but Hugo doesn't seem to always resolve the conflict in the same way: locally +# I see the docs landing page win, but on Netlify I see the site home page win. +# Let's avoid the conflict by hiding the home page when building a doc-rooted +# site variant. This config isn't necessary for regular doc-rooted sites. + +disableKinds: [home] diff --git a/docsy.dev/config/doc-rooted/params.yaml b/docsy.dev/config/doc-rooted/params.yaml new file mode 100644 index 0000000000..08c8012be8 --- /dev/null +++ b/docsy.dev/config/doc-rooted/params.yaml @@ -0,0 +1,13 @@ +# cSpell:ignore pagelinks + +version: &docsyVersion 0.14.2 +version_menu: *docsyVersion +versions: + - name: Next + kind: next + url: https://main--docsydocs.netlify.app/ + pagelinks: false + - version: *docsyVersion + kind: latest + url: https://www.docsy.dev + pagelinks: false diff --git a/docsy.dev/config/production/params.yaml b/docsy.dev/config/production/params.yaml index 8f4a93cd67..0a43f7d698 100644 --- a/docsy.dev/config/production/params.yaml +++ b/docsy.dev/config/production/params.yaml @@ -1,9 +1,13 @@ +# cSpell:ignore pagelinks + version: &docsyVersion 0.14.2 version_menu: *docsyVersion versions: - name: Next kind: next url: https://main--docsydocs.netlify.app/ + pagelinks: true - version: *docsyVersion kind: latest url: https://www.docsy.dev + pagelinks: true diff --git a/docsy.dev/content/en/docs/content/navigation.md b/docsy.dev/content/en/docs/content/navigation.md index eab95b12ad..4a93234517 100644 --- a/docsy.dev/content/en/docs/content/navigation.md +++ b/docsy.dev/content/en/docs/content/navigation.md @@ -751,11 +751,11 @@ To create a heading ID alias: For example, if you rename "Getting Started" to "Quickstart": ```html -## Quickstart {#quickstart} +## Quickstart {#quickstart} ``` -Now both `#getting-started` and `#quickstart` target the same heading and scroll -to the right place. +Now both `#get-started` and `#quickstart` target the same heading and scroll to +the right place. Give the heading alias for this section a try: [Heading aliases](#a-heading-aliases).[^might-not-scroll] diff --git a/docsy.dev/content/en/docs/content/shortcodes/index.md b/docsy.dev/content/en/docs/content/shortcodes/index.md index 84803b226e..4107b94a45 100644 --- a/docsy.dev/content/en/docs/content/shortcodes/index.md +++ b/docsy.dev/content/en/docs/content/shortcodes/index.md @@ -623,16 +623,23 @@ This code translates to the right aligned tabbed pane below, showing a `Welcome!` greeting in English, German or Swahili: +{{< comment >}} + +Note: we use a Markdown call to the German-flag tab below so that the image link +resolves correctly under doc-rooted builds. I'll keep the HTML call of the tab +in the go-html-template block above for illustrative purposes. + +{{< /comment >}} {{< tabpane text=true right=true >}} {{% tab header="**Languages**:" disabled=true /%}} {{% tab header="English" lang="en" %}} ![Flag United Kingdom](flags/uk.png) **Welcome!** {{% /tab %}} - {{< tab header="German" lang="de" >}} - Flag Germany - Herzlich willkommen! - {{< /tab >}} + {{% tab header="German" lang="de" %}} + ![Flag Germany](flags/de.png) + **Herzlich willkommen!** + {{% /tab %}} {{% tab header="Swahili" lang="sw" %}} ![Flag Tanzania](flags/tz.png) **Karibu sana!** @@ -732,7 +739,7 @@ shows the first four Presidents of the United States: header="**George Washington**" title="\*1732     †1799" subtitle="**President:** 1789 – 1797" - footer="![Signature George Washington](/docs/content/shortcodes/card-pane/george-washington-signature.png)" + footer="![Signature George Washington](card-pane/george-washington-signature.png)" %}} ![George Washington](card-pane/george-washington-portrait.jpg) {{% /card %}} @@ -741,7 +748,7 @@ shows the first four Presidents of the United States: header="**John Adams**" title="\*1735     †1826" subtitle="**President:** 1797 – 1801" - footer="![Signature John Adams](/docs/content/shortcodes/card-pane/john-adams-signature.png)" + footer="![Signature John Adams](card-pane/john-adams-signature.png)" %}} ![John Adams](card-pane/john-adams-portrait.jpg) {{% /card %}} @@ -750,7 +757,7 @@ shows the first four Presidents of the United States: header="**Thomas Jefferson**" title="\*1743     †1826" subtitle="**President:** 1801 – 1809" - footer="![Signature Thomas Jefferson](/docs/content/shortcodes/card-pane/thomas-jefferson-signature.png)" + footer="![Signature Thomas Jefferson](card-pane/thomas-jefferson-signature.png)" %}} ![Thomas Jefferson](card-pane/thomas-jefferson-portrait.jpg) {{% /card %}} @@ -759,7 +766,7 @@ shows the first four Presidents of the United States: header="**James Madison**" title="\*1751     †1836" subtitle="**President:** 1809 – 1817" - footer="![Signature James Madison](/docs/content/shortcodes/card-pane/james-madison-signature.png)" + footer="![Signature James Madison](card-pane/james-madison-signature.png)" %}} ![James Madison](card-pane/james-madison-portrait.jpg) {{% /card %}} @@ -811,7 +818,7 @@ indicates and explains the individual components of a card: header="**Imagine**" title="Artist and songwriter: John Lennon" subtitle="Co-writer: Yoko Ono" - footer="![SignatureJohnLennon](/docs/content/shortcodes/card-pane/john-lennon-signature.png)" + footer="![SignatureJohnLennon](card-pane/john-lennon-signature.png)" >}} Imagine there's no heaven, It's easy if you try
diff --git a/docsy.dev/content/en/docs/contributing.md b/docsy.dev/content/en/docs/contributing.md index f6e142c37a..cea31caef8 100644 --- a/docsy.dev/content/en/docs/contributing.md +++ b/docsy.dev/content/en/docs/contributing.md @@ -1,7 +1,10 @@ --- title: Contribution guidelines description: How to contribute to Docsy -aliases: [contribution-guidelines] +aliases: + - contributing + - contribution-guidelines + - /docs/contribution-guidelines # TODO: drop once redirects are in place. This is only for doc-rooted example site weight: 9 --- @@ -106,8 +109,8 @@ Docsy has a shortcut for you: If you want to run your own local Hugo server to preview your changes as you work: -1. Follow the instructions in [Getting started](/docs/getting-started) to - install Hugo and any other tools you need. +1. Follow the instructions in [Getting started](get-started) to install Hugo and + any other tools you need. 1. Fork the [Docsy](https://github.com/google/docsy) repo into your own project, then create a local copy using `git clone`: diff --git a/docsy.dev/content/en/docs/get-started/_index.md b/docsy.dev/content/en/docs/get-started/_index.md index 80b4ea6097..40103867a1 100644 --- a/docsy.dev/content/en/docs/get-started/_index.md +++ b/docsy.dev/content/en/docs/get-started/_index.md @@ -4,7 +4,9 @@ description: >- Learn how to get started with Docsy, including the available options for installing and using the Docsy theme. date: 2018-07-30 -aliases: [getting-started] +aliases: + - getting-started + - /docs/get-started # TODO: drop once redirects are in place. This is only for doc-rooted example site weight: 2 --- diff --git a/docsy.dev/static/refcache.json b/docsy.dev/static/refcache.json index 1be2b932d5..4f7201df64 100644 --- a/docsy.dev/static/refcache.json +++ b/docsy.dev/static/refcache.json @@ -2223,6 +2223,10 @@ "StatusCode": 206, "LastSeen": "2026-02-11T11:18:51.084674-05:00" }, + "https://main--docsydocs.netlify.app": { + "StatusCode": 206, + "LastSeen": "2026-02-17T06:15:14.691378-05:00" + }, "https://main--docsydocs.netlify.app/": { "StatusCode": 206, "LastSeen": "2026-02-11T11:24:06.451949-05:00" @@ -2799,6 +2803,10 @@ "StatusCode": 200, "LastSeen": "2026-02-11T11:14:23.171612-05:00" }, + "https://www.docsy.dev": { + "StatusCode": 206, + "LastSeen": "2026-02-17T06:15:15.454399-05:00" + }, "https://www.docsy.dev/": { "StatusCode": 206, "LastSeen": "2026-02-11T11:24:06.577733-05:00" diff --git a/layouts/_shortcodes/card.html b/layouts/_shortcodes/card.html index f35ccd846a..503624df7c 100644 --- a/layouts/_shortcodes/card.html +++ b/layouts/_shortcodes/card.html @@ -15,18 +15,18 @@
{{ with $.Get "header" -}}
- {{ . | markdownify }} + {{ . | $.Page.RenderString }}
{{ end -}}
{{ with $.Get "title" -}}
- {{ . | markdownify -}} + {{ . | $.Page.RenderString -}}
{{ end -}} {{ with $.Get "subtitle" -}}
- {{ . | markdownify -}} + {{ . | $.Page.RenderString -}}
{{ end -}} {{ with $.Inner -}} @@ -41,7 +41,7 @@
{{ with $.Get "footer" -}} {{ end -}}
diff --git a/package.json b/package.json index a900d24bf1..ebc6d546a4 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "docsy", - "version": "0.14.3-dev+009-over-main-601fd46d", + "version": "0.14.3-dev+010-over-main-1aae2c92", "repository": "github:google/docsy", "homepage": "https://www.docsy.dev", "license": "Apache-2.0",