This site provides a machine-readable index at /llms.txt.

Skip to main content Skip to navigation

Mark drafts, tag pages, and control sort order

To keep an unfinished page out of navigation, attach grouping keywords to a page, or change where a page appears within its sidebar section, set one of three front-matter keys. For how front matter is parsed, see Work with front matter.

Assumptions

  • A working Pennington site has markdown under Content/ (see Work with front matter if not)
  • Pages use a front-matter record that implements the capability each key relies on (see the applicability note below)
  • The sidebar currently renders in file-order; TableOfContentsNavigation has not been customized

Which front-matter types support which keys

isDraft: is always available — IFrontMatter has a default IsDraft member that every record inherits. tags: and order: only apply to records that opt in through ITaggable and IOrderable respectively.

Front-matter type isDraft: tags: order:
DocSiteFrontMatter (default after AddDocSite) yes yes yes
BlogSiteFrontMatter (default after AddBlogSite) yes yes no — date-driven ordering instead
DocFrontMatter (bare-host default) yes yes yes
BlogFrontMatter (bare-host default) yes yes no
Custom record depends on which capability interfaces it implements

Setting order: on a BlogSiteFrontMatter page has no effect — blog posts sort newest-first by date:. To reorder posts, adjust the date; to hide a post, use isDraft: true.

Options

Hide an unfinished page with isDraft: true

Setting isDraft: true keeps the page compiled — xref: links targeting it still resolve — but drops it from navigation, search, and llms.txt.

---
title: Coming soon
isDraft: true
---

The default is false. For the full key catalog, see Front matter key reference.

Tag a page for grouping

tags: accepts a free-form string array that flows through ITaggable into RenderedContent.Tags, making it available to client-side filtering widgets and future tag-index pages. Pennington does not currently emit /tags/<name> pages for DocSite — tag routing requires a custom content service.

---
title: Deep dive
tags: [advanced, performance, pipeline]
---

Backing symbol on the DocSite front-matter record:

/// <summary>Tags applied to this page for filtering and the tag index.</summary>
public string[] Tags { get; init; } = [];

Order a page inside its section

Lower order: values sort earlier within a section. A section inherits its own sort key from the minimum order: among its children, so changing one page can reshuffle the whole section. Spacing like 10/20/30 leaves room for later inserts between existing siblings.

---
title: Install
order: 10
---

Backing symbol:

/// <summary>Sort order within the containing section. Lower values appear first.</summary>
public int Order { get; init; } = int.MaxValue;

Verify

  • Run dotnet run — the drafted page's URL still responds 200 but is absent from the sidebar and from /search-index.json
  • The tagged page's HTML carries the tag strings in its rendered output (inspect RenderedContent.Tags or the page body)
  • Sidebar entries within the section appear in ascending order: — swap two values and the order flips on next reload
Previous
Next