Skip to content
Open
Show file tree
Hide file tree
Changes from 2 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
32 changes: 16 additions & 16 deletions docsy.dev/content/en/docs/content/adding-content.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ params:

> [!DANGER] Danger Will Robinson!
# prettier-ignore
cSpell:ignore: goldmark Riona MacNamara frontmatter asciidoctor pandoc changefreq
cSpell:ignore: goldmark Riona MacNamara asciidoctor pandoc changefreq
---

So you've got a new Hugo website with Docsy, now it's time to add some content!
Expand Down Expand Up @@ -86,10 +86,10 @@ If you've copied the example site and _don't_ want to use one of the provided
content sections, just delete the appropriate content subdirectory. Similarly,
if you want to add a top-level section, just add a new subdirectory, though
you'll need to specify the layout or content type explicitly in the
[frontmatter](#page-frontmatter) of each page if you want to use any existing
[front matter](#page-front-matter) of each page if you want to use any existing
Docsy template other than the default one. For example, if you create a new
directory `content/en/amazing` and want one or more pages in that custom section
to use Docsy's `docs` template, you add `type: docs` to the frontmatter of each
to use Docsy's `docs` template, you add `type: docs` to the front matter of each
page:

<!-- markdownlint-disable -->
Expand Down Expand Up @@ -280,17 +280,17 @@ navigation menu.
An example docs-based site that uses this technique can be found at the
[mostly docs](https://github.com/gwatts/mostlydocs/) repo.

## Page frontmatter
## Page front matter

Each page file in a Hugo site has metadata frontmatter that tells Hugo about the
page. You specify page frontmatter in TOML, YAML, or JSON (our example site and
this site use YAML). Use the frontmatter to specify the page title, description,
Each page file in a Hugo site has metadata front matter that tells Hugo about the
page. You specify page front matter in TOML, YAML, or JSON (our example site and
this site use YAML). Use the front matter to specify the page title, description,
creation date, link title, template, menu weighting, and even any resources such
as images used by the page. You can see a complete list of possible page
frontmatter in
front matter in
[Front Matter](https://gohugo.io/content-management/front-matter/).

For example, here's the frontmatter for this page:
For example, here's the front matter for this page:

<!-- markdownlint-disable -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -327,7 +327,7 @@ description: >
<!-- prettier-ignore-end -->
<!-- markdownlint-restore -->

The minimum frontmatter you need to provide is a title: everything else is up to
The minimum front matter you need to provide is a title: everything else is up to
you! However, if you leave out the page weight, your
[navigation](/docs/content/navigation) may get a little disorganized. You may
also want to include `description` since Docsy uses that to generate the meta
Expand All @@ -338,7 +338,7 @@ details.
## Page content

Most often you create pages in a Docsy site as [Markdown or HTML files][formats]
with [page frontmatter](#page-frontmatter). Hugo's default markup and markdown
with [page front matter](#page-front-matter). Hugo's default markup and markdown
renderer is [Goldmark].

### Markdown
Expand Down Expand Up @@ -500,12 +500,12 @@ organizing your content with Docsy in

By default a docs section landing page (the `_index.md` or `_index.html` in the
section directory) uses a layout that adds a formatted list of links to the
pages in the section, with their frontmatter descriptions. The
pages in the section, with their front matter descriptions. The
[Content and Customization](/docs/content/) landing page in this site is a good
example.

To display a simple bulleted list of links to the section's pages instead,
specify `simple_list: true` in the landing page's frontmatter:
specify `simple_list: true` in the landing page's front matter:

<!-- markdownlint-disable -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -537,7 +537,7 @@ weight: 20
<!-- markdownlint-restore -->

To display no links at all, specify `no_list: true` in the landing page's
frontmatter:
front matter:

<!-- markdownlint-disable -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -613,7 +613,7 @@ weight: 20
<!-- markdownlint-restore -->

To add author and date information to blog posts, add them to the page
frontmatter:
front matter:

<!-- markdownlint-disable -->
<!-- prettier-ignore-start -->
Expand Down Expand Up @@ -971,7 +971,7 @@ sitemap:
<!-- prettier-ignore-end -->

To override any of these values for a given page, specify it in page
frontmatter:
front matter:

<!-- markdownlint-disable -->
<!-- prettier-ignore-start -->
Expand Down
4 changes: 2 additions & 2 deletions docsy.dev/content/en/docs/content/feedback.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ date: 2019-06-05
description: >-
Add Google Analytics tracking to your site, collect user feedback and learn
about the page description meta tag.
cSpell:ignore: fabform pageviews frontmatter
cSpell:ignore: fabform pageviews
weight: 8
---

Expand Down Expand Up @@ -299,7 +299,7 @@ For each generated page, Docsy will set the content of the meta `description` by
using the first of the following that is defined:

- The page `description`
[frontmatter field](/docs/content/adding-content/#page-frontmatter)
[front matter field](/docs/content/adding-content/#page-front-matter)
- For non-index pages, the page [summary][], as computed by Hugo
- The site description taken from the [site `params`][]

Expand Down
4 changes: 2 additions & 2 deletions docsy.dev/content/en/docs/content/navigation.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ title: Navigation and Menus
date: 2017-01-05
weight: 3
description: Customize site navigation for your Docsy site.
cSpell:ignore: navs lightdark lookandfeel frontmatter notoc
cSpell:ignore: navs lightdark lookandfeel notoc
---

Docsy provides multiple built-in navigation features for your sites, including
Expand Down Expand Up @@ -419,7 +419,7 @@ By default the side nav is entirely generated from your section's pages. If you
want to add a manual link to this menu, such as a link to an external site or a
page in a different section of your site, you can do this by creating a
_placeholder page file_ in the doc hierarchy with the appropriate weight and
some special parameters in its metadata (frontmatter) to specify the link
some special parameters in its metadata (front matter) to specify the link
details.

To create a placeholder page, create a page file as usual in the directory where
Expand Down
2 changes: 1 addition & 1 deletion docsy.dev/content/en/docs/content/search.md
Original file line number Diff line number Diff line change
Expand Up @@ -371,7 +371,7 @@ If you want to limit the width, add the following scss into
### Excluding pages from local search results

To exclude pages from local search results, add `exclude_search: true` to the
the frontmatter of each page:
the front matter of each page:

<!-- markdownlint-disable -->
<!-- prettier-ignore-start -->
Expand Down
Loading