diff --git a/CHANGELOG.md b/CHANGELOG.md index 63195c5a6f..e5708b97da 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -69,7 +69,7 @@ For the full list of changes, see the [0.x.y] release notes. [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/_default/td-content-after-header.html + https://github.com/google/docsy/blob/main/layouts/td-content-after-header.html ## 0.11.0 diff --git a/layouts/_default/single.html b/layouts/_default/single.html deleted file mode 100644 index 8362338e45..0000000000 --- a/layouts/_default/single.html +++ /dev/null @@ -1,3 +0,0 @@ -{{ define "main" -}} -{{ .Content -}} -{{ end }} diff --git a/layouts/_default/list.html b/layouts/all.html similarity index 100% rename from layouts/_default/list.html rename to layouts/all.html diff --git a/layouts/_default/baseof.html b/layouts/baseof.html similarity index 100% rename from layouts/_default/baseof.html rename to layouts/baseof.html diff --git a/layouts/_default/content.html b/layouts/content.html similarity index 100% rename from layouts/_default/content.html rename to layouts/content.html diff --git a/layouts/home.html b/layouts/home.html deleted file mode 100644 index b2e137af6f..0000000000 --- a/layouts/home.html +++ /dev/null @@ -1,5 +0,0 @@ -{{ define "main" }} -{{ with .Content }} -{{ . }} -{{ end }} -{{ end }} \ No newline at end of file diff --git a/layouts/_default/search.html b/layouts/search.html similarity index 100% rename from layouts/_default/search.html rename to layouts/search.html diff --git a/layouts/_default/td-content-after-header.html b/layouts/td-content-after-header.html similarity index 100% rename from layouts/_default/td-content-after-header.html rename to layouts/td-content-after-header.html diff --git a/userguide/.htmltest.yml b/userguide/.htmltest.yml index 7abc8a7e49..760b30ce4c 100644 --- a/userguide/.htmltest.yml +++ b/userguide/.htmltest.yml @@ -22,3 +22,6 @@ IgnoreURLs: # list of regexs of paths or URLs to be ignored # Too flaky or unnecessary - ^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 diff --git a/userguide/content/en/docs/adding-content/lookandfeel.md b/userguide/content/en/docs/adding-content/lookandfeel.md index 42a6b21589..13174c2989 100644 --- a/userguide/content/en/docs/adding-content/lookandfeel.md +++ b/userguide/content/en/docs/adding-content/lookandfeel.md @@ -3,7 +3,8 @@ title: Look and Feel date: 2017-01-05 weight: 2 description: Customize colors, fonts, code highlighting, and more for your site. -spelling: cSpell:ignore wordmark docsy myclass anotherclass +# prettier-ignore +cSpell:ignore: anotherclass autoprefixing baseof blockscover docsy lightdark monokai myclass onedark wordmark --- By default, a site using Docsy has the theme's default fonts, colors, and @@ -492,6 +493,11 @@ Similarly, if you want to add some code right before the `body` end, create your own version of [hooks/body-end.html]. This partial is included automatically at the end of the theme partial [scripts.html]. +Both [head.html] and [scripts.html] are included from [baseof.html], Docsy's +[base template][]. + +[baseof.html]: https://github.com/google/docsy/blob/main/layouts/baseof.html +[base template]: https://gohugo.io/templates/base/ [head.html]: https://github.com/google/docsy/blob/main/layouts/_partials/head.html [hooks/body-end.html]: @@ -501,32 +507,6 @@ the end of the theme partial [scripts.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), -which is used by all the other page templates: - - -```html - - -
- {{ partial "head.html" . }} - - -