Feature index
Every Markus directive and Markdown feature, each with a page of examples.
Every directive in the Markus registry and every Markdown feature it renders has a page here. Each page lists the attributes, then shows every variant as Markus source beside the result it renders. On narrow screens the source sits above the preview.
Markus ships with 26 themes. Pick one from the Theme menu at the top of any page to see every example on the site re-rendered in it.
- ◐ Light and dark: Markus (the default), Solarized, Catppuccin, Everforest, Flexoki, GitHub, Gruvbox, Kanagawa, One, Rosé Pine, and Tokyo Night carry both palettes and follow your system setting, or the Auto/Light/Dark switch.
- ○ Light only and ● dark only: the remaining themes always render in one mode.
Apply a theme to your own pages with theme: in front matter or markus convert --theme NAME. A light-and-dark theme follows the reader's prefers-color-scheme; set data-color-scheme="light" or "dark" on the root element to force one.
Directives
| Directive | Kind | Page |
|---|---|---|
callout |
container | Callouts and asides |
note, tip, warning, caution |
container aliases | Callouts and asides |
aside |
container | Callouts and asides |
pull-quote |
container | Pull quote |
details |
container | Details |
editorial-finding |
container | Editorial finding |
example |
container | Example |
card-grid, feature-grid |
container | Card grid and cards |
card, feature-card |
container | Card grid and cards |
two-up, column |
container | Two-up and columns |
tabs, tab |
container | Tabs |
figure |
container | Figure and video |
video |
leaf | Figure and video |
metric |
leaf | Metric |
bar-chart |
container | Bar chart |
step-list, step |
container | Step list |
timeline, timeline-event |
container | Timeline |
conversation, message-group, message |
container | Conversation |
diagram, row, node |
container | Diagram |
link |
leaf | Diagram |
Language
| Feature | Page |
|---|---|
| Front matter, container and leaf syntax, attributes, ids, nesting, validation | Syntax and metadata |
| Headings, emphasis, links, images, lists, task lists, tables, code, quotes, alerts, breaks | GitHub Flavored Markdown |
==text== highlights |
Highlight |
Generated heading ids and {#custom-id} |
Heading anchors |
| Alignment, wrapping, numeric columns, scrolling, captions | Tables |
Elsewhere
- Get started: install, the command line, and the Python API.
- Gallery: every directive on one page.
- Markus and GFM: the Markdown baseline Markus keeps on purpose.