Skip to content
Norn
Menu

norn-docs-home

A docs site's home page: the hero with the install sample, then the docs pages as a contents list, each title and then its description. Extends norn-base. The page body follows the sections, in a section of its own, in norn-rich-text. Markdown is compiled once, as on norn-docs, and a page with no body renders no section. The install sample is a norn-code-block: highlighted with @allons-y/webc-code-sample, and a plain <pre><code> without it. Its texts ("Get started", "Read the docs", "View on GitHub", "Documentation") come from componentStrings under norn-docs-home, then English.

layout: norn-docs-home.webc a template, from @allons-y/webc-patterns

Examples

Color scheme
Width

Open on its own

Source
---
title: Default
order: 1
layout: norn-docs-home.webc
---

Props

The plugin's props mapping sets them on each page, and the layout reads them as $data.norn.

NameTypeDescription
lede string The hero paragraph. Falls back to the description.
install string The install command.
repo string The repository's URL.
docs { href: string, title: string, description?: string }[] The docs pages, in order.

Slots

NameDescription
default The page body, after the sections: Markdown or WebC, compiled once. A page with no body renders no section.

Tokens

The global tokens from tokens.json the component reads. Set one in a project's tokens.css to change it everywhere.

Type a value to try it in every example above. Reset puts the default back.

Token Type Default Override
--norn-ui-accentThe brand color, shared by every component. <color> #2346d4
--norn-ui-border-radiusCorner radius. <length> 6px
--norn-ui-focus-widthFocus ring width. One ring on every focusable element. <length> 2px
--norn-ui-focus-offsetGap between an element and its focus ring. An element the ring would clip draws it inset, at the negative of this. <length> 2px
--norn-ui-state-hoverShare of the text color mixed into the background while the pointer is over a control. <percentage> 8%
--norn-ui-state-pressShare of the text color mixed into the background while a control is pressed, and of the accent on a selected or current item. <percentage> 12%
--norn-text-mutedSecondary text color. <color> light-dark(#4b5160, #a4abba)
--norn-text-accentThe accent for text and links: darkened in light mode, lightened in dark mode. The lightness caps keep any accent at 4.5:1 or better. <color> light-dark(oklch(from color-mix(in oklch, var(--norn-ui-accent, #2346d4) 82%, black) min(l, 0.5) c h), oklch(from color-mix(in oklch, var(--norn-ui-accent, #2346d4) 55%, white) max(l, 0.72) c h))
--norn-font-headingHeading face. Follows the body face until the project sets one. <font-family> var(--norn-font-body, ui-sans-serif, system-ui, -apple-system, "Segoe UI", Roboto, sans-serif)
--norn-font-size-mBody text. <length> 1rem
--norn-space-2xsSmallest spacing step. <length> 0.25rem
--norn-space-sSmall spacing step. <length> 0.75rem
--norn-space-mMedium spacing step. <length> 1.25rem