Skip to content
Norn
Menu

norn-workspace

One workspace's page in the docs frame: the workspaces sidebar, its name, its description, and its page, such as its SKILL.md or README.md rendered to HTML. Extends norn-base. The page's own content follows the workspace's, so a pagination template can leave its body empty. The sidebar's name ("Packages") comes from componentStrings under norn-workspace, then English.

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

Examples

Color scheme
Width

Open on its own

Source
---
title: Default
order: 1
layout: norn-workspace.webc
---
Color scheme
Width

Open on its own

Source
---
title: Second workspace
order: 2
layout: norn-workspace.webc
---

Props

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

NameTypeDescription
workspaces { href: string, title: string, icon?: string }[] The workspaces, for the sidebar.
workspace { name: string, description?: string, html?: string } The workspace on this page. Its html is compiled as WebC, so it may hold components.

Slots

NameDescription
default The page's own content, in norn-rich-text after the workspace's page.