Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion assets/stubs/new-page-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docsy.dev/config/_default/params.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
7 changes: 7 additions & 0 deletions docsy.dev/config/doc-rooted/hugo.yaml
Original file line number Diff line number Diff line change
@@ -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]
13 changes: 13 additions & 0 deletions docsy.dev/config/doc-rooted/params.yaml
Original file line number Diff line number Diff line change
@@ -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
4 changes: 4 additions & 0 deletions docsy.dev/config/production/params.yaml
Original file line number Diff line number Diff line change
@@ -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
6 changes: 3 additions & 3 deletions docsy.dev/content/en/docs/content/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -751,11 +751,11 @@ To create a heading ID alias:
For example, if you rename "Getting Started" to "Quickstart":

```html
## Quickstart <a id="getting-started"></a> {#quickstart}
## Quickstart <a id="get-started"></a> {#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]
Expand Down
25 changes: 16 additions & 9 deletions docsy.dev/content/en/docs/content/shortcodes/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -623,16 +623,23 @@ This code translates to the right aligned tabbed pane below, showing a
`Welcome!` greeting in English, German or Swahili:

<!-- prettier-ignore-start -->
{{< 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" >}}
<img src="/docs/content/shortcodes/flags/de.png" alt="Flag Germany">
<b>Herzlich willkommen!</b>
{{< /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!**
Expand Down Expand Up @@ -732,7 +739,7 @@ shows the first four Presidents of the United States:
header="**George Washington**"
title="\*1732 &nbsp;&nbsp;&nbsp; †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 %}}
Expand All @@ -741,7 +748,7 @@ shows the first four Presidents of the United States:
header="**John Adams**"
title="\*1735 &nbsp;&nbsp;&nbsp; †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 %}}
Expand All @@ -750,7 +757,7 @@ shows the first four Presidents of the United States:
header="**Thomas Jefferson**"
title="\*1743 &nbsp;&nbsp;&nbsp; †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 %}}
Expand All @@ -759,7 +766,7 @@ shows the first four Presidents of the United States:
header="**James Madison**"
title="\*1751 &nbsp;&nbsp;&nbsp; †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 %}}
Expand Down Expand Up @@ -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<br/>
Expand Down
9 changes: 6 additions & 3 deletions docsy.dev/content/en/docs/contributing.md
Original file line number Diff line number Diff line change
@@ -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
---

Expand Down Expand Up @@ -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`:

Expand Down
4 changes: 3 additions & 1 deletion docsy.dev/content/en/docs/get-started/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
---

Expand Down
8 changes: 8 additions & 0 deletions docsy.dev/static/refcache.json
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down Expand Up @@ -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"
Expand Down
8 changes: 4 additions & 4 deletions layouts/_shortcodes/card.html
Original file line number Diff line number Diff line change
Expand Up @@ -15,18 +15,18 @@
<div class="td-card card border me-4">
{{ with $.Get "header" -}}
<div class="card-header{{- cond $code " code" "" -}}">
{{ . | markdownify }}
{{ . | $.Page.RenderString }}
</div>
{{ end -}}
<div class="card-body{{- cond $code " code p-0 m-0" "" -}}">
{{ with $.Get "title" -}}
<h5 class="card-title">
{{ . | markdownify -}}
{{ . | $.Page.RenderString -}}
</h5>
{{ end -}}
{{ with $.Get "subtitle" -}}
<h6 class="card-title ms-2 text-body-secondary">
{{ . | markdownify -}}
{{ . | $.Page.RenderString -}}
</h6>
{{ end -}}
{{ with $.Inner -}}
Expand All @@ -41,7 +41,7 @@ <h6 class="card-title ms-2 text-body-secondary">
</div>
{{ with $.Get "footer" -}}
<div class="card-footer">
{{ . | markdownify -}}
{{ . | $.Page.RenderString -}}
</div>
{{ end -}}
</div>
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
Loading