Move layouts/_default/_markup one level up, adjusts UG (#2246)

This commit is contained in:
Patrice Chalin 2025-05-16 07:00:24 -04:00 committed by GitHub
parent 619fd0c5a9
commit dba24fe5e3
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
10 changed files with 15 additions and 9 deletions

View File

@ -29,6 +29,8 @@ For the full list of changes, see the [0.x.y] release notes.
- Renames the default Docsy heading render hook and heading self-link partials.
This is a breaking change only if your project uses this feature. For details,
see [Heading self links][] ([#2223]).
- Relocates and adapts layouts in response to Hugo's updated template system.
For details, see [Adapt to new template system in Hugo v0.146.0 #2243][#2243].
**Potential breaking changes**:
@ -60,6 +62,7 @@ For the full list of changes, see the [0.x.y] release notes.
[#2160]: https://github.com/google/docsy/pull/2160
[#2192]: https://github.com/google/docsy/pull/2192
[#2223]: https://github.com/google/docsy/pull/2223
[#2243]: https://github.com/google/docsy/pull/2243
[Breadcrumb navigation]:
https://www.docsy.dev/docs/adding-content/navigation/#breadcrumb-navigation
[content type]: https://gohugo.io/quick-reference/glossary/#content-type

View File

@ -18,7 +18,7 @@ outputFormats:
module:
hugoVersion:
extended: true
min: 0.110.0
min: 0.146.0
mounts:
- source: assets
target: assets

View File

@ -44,7 +44,7 @@ top-level site sections that you might need:
for your site's Community page.
It also provides a
[default "landing page" type of template](https://github.com/google/docsy/tree/main/layouts/_default)
[default "landing page" type of template](https://github.com/google/docsy/tree/main/layouts/)
with the site header and footer, but no left nav, that you can use for any other
section. In this site and our example site it's used for the site [home page](/)
and the [About](/about/) page.
@ -117,11 +117,10 @@ about how to add content and use each of Docsy's templates.
### Alternative site structure
As noted above, by default your site has a home page (using the `_default`
layout), a docs section under `/docs/`, a blog section under `/blog/` and a
community section under `/community/`.
[The type](https://gohugo.io/content-management/types/) of each section (which
determines the layout it uses) matches its directory name.
As noted above, by default your site has a home page, a docs section under
`/docs/`, a blog section under `/blog/` and a community section under
`/community/`. [The type](https://gohugo.io/content-management/types/) of each
section (which determines the layout it uses) matches its directory name.
In some cases, you may want to have a different directory structure, but still
make use of Docsy's layouts. A common example is for a "docs site", where most

View File

@ -443,7 +443,7 @@ Docsy supports build-time generation of heading self links using Hugo's
`render-heading.html` [hook].
To enable this feature in your project, define
`layouts/_default/_markup/render-heading.html` as:
`layouts/_markup/render-heading.html` as:
```go-html-template
{{ partial "td/render-heading.html" . }}

View File

@ -10,7 +10,7 @@ This page describes the prerequisites for building a site that uses Docsy as a H
## Install Hugo
You need a [recent **extended** version](https://github.com/gohugoio/hugo/releases) (version 0.110.0 or later) of [Hugo](https://gohugo.io/) to do local builds and previews of sites (like this one) that use Docsy. If you install from the release page, make sure to get the `extended` Hugo version, which supports [SCSS](https://sass-lang.com/documentation/file.SCSS_FOR_SASS_USERS.html); you may need to scroll down the list of releases to see it.
You need a [recent **extended** version](https://github.com/gohugoio/hugo/releases) (version 0.146.0 or later) of [Hugo](https://gohugo.io/) to do local builds and previews of sites (like this one) that use Docsy. If you install from the release page, make sure to get the `extended` Hugo version, which supports [SCSS](https://sass-lang.com/documentation/file.SCSS_FOR_SASS_USERS.html); you may need to scroll down the list of releases to see it.
For comprehensive Hugo documentation, see [gohugo.io](https://gohugo.io).

View File

@ -579,6 +579,10 @@
"StatusCode": 206,
"LastSeen": "2025-04-24T08:05:34.239565-04:00"
},
"https://github.com/google/docsy/pull/2243": {
"StatusCode": 206,
"LastSeen": "2025-05-16T06:49:30.016774-04:00"
},
"https://github.com/google/docsy/pulls": {
"StatusCode": 200,
"LastSeen": "2024-11-06T12:03:15.642661-05:00"