Skip to content
DocPensieve
Documentation menu

Components

Module progress100%

Lesson 2 of 2 — the last one of this module.

A comparison, in columns

A page that compares two ways of working reads better side by side:

A list written by hand
Goes stale at the first page renamed. Nothing tells you.
A grid of cards
Built from the pages on every build. It cannot go stale.

A dashboard, in gauges

Where a team tracks the state of its documentation:

82%
Pages reviewed
95%
Examples tested
40%
Translated

A warning the reader cannot walk past

Some sentences must not be read as prose. An admonition lifts them out:

Kinds this site added

Six kinds ship with the tool; these two are declared in the configuration of this very site, with a mark taken from an icon set:

// docpensieve.config.mjs
admonitions: {
  claude: { label: 'Claude', tone: 'info', icon: 'simple-icons:claude' },
},

The mark is placed in the page when the site is built, like every other icon here: your reader downloads nothing, and no request leaves their browser.

A term, explained in place

A reader who does not know what a betaA version published before the stable one, to try what is coming. finds out without leaving the sentence — with the mouse or from the keyboard.

Check yourself

How many scripts does this page load?

None. Every component here is rendered when the site is built.

This lesson uses Columns, Card, Skill, Tooltip and Admonition.

Well done

You have finished Writing well. The site holds real pages now; the next module makes it look and move like yours.

Next module: Making it yours
Colours, navigation, and blocks that stop a reader in time.