Skip to main content

Formatting reference

This page shows every block these docs use, so writers can check how a page will look before they open a merge request. Copy it into any Docusaurus site with this theme to check the theme itself.

Admonitions​

note

A note adds context the reader can skip.

tip

A tip saves the reader a step, like running zecnero-miner status after an update.

info

Info states a fact the reader needs, such as the 100-block coinbase maturity.

TODO

We use caution for TODOs: anything a maintainer must confirm before the page ships. Say exactly what to check.

danger

Danger warns about lost coins or broken nodes. Use it rarely.

Inline elements​

Body text is IBM Plex Sans at 16 px. Inline code such as zecnerod --testnet sits on a tinted ground. Links like this one to the code section carry an orange underline. Strong text uses weight 600.

Heading 3​

Headings use Chakra Petch.

Heading 4​

The smallest heading is the body size in Chakra Petch 600.

Code​

Terminal
zecnero-miner status
zecnero-miner logs
sha256sum ./downloaded-file

Table​

BlockUse it for
NoteContext the reader can skip
CautionA TODO a maintainer must clear
DangerLost coins or broken nodes

Diagram​