Dev Lab¶
A temporary tab. Every element Material for MkDocs can render, shown rendered first and its Markdown source
right under it, so you can pick what the manuals will use by looking. Delete this tab from mkdocs.yml before
the first release.
How to read these pages
Each example is a rendered block followed by a code block with the exact Markdown that produced it. Copy the
source into any page. Where an element needs an entry in mkdocs.yml (an extension or a plugin), the page
says so; everything shown is already switched on in this build.
Pages¶
| Page | What is in it |
|---|---|
| Admonitions | the twelve callout types, custom titles, collapsible, nested, inline |
| Text, lists and tooltips | emphasis, marks, critic edits, keys, symbols, abbreviations, footnotes, definition and task lists, emoji, icons, buttons |
| Code blocks | titles, line numbers, highlighted lines, annotations, inline code, embedded files, many languages |
| Tabs and tables | content tabs (linked), tables with alignment, sortable tables, icons in cells |
| Images, figures and grids | sizes, alignment, captions, zoom, light/dark variants, card grids, generic grids |
| Diagrams and math | flowchart, sequence, state, class and pie diagrams; inline and block math |
| Page and site features | front matter (status, tags, hide, search), and the theme features that are on, off, or need a plugin |
Already visible on every page¶
- the announcement bar above the header (dismissable),
- the version selector next to the site name and the older version banner on the versioned preview,
- the language selector and the repository card on the right of the header,
- the light/dark toggle,
- search with suggestions, highlighting and a share button,
- Previous / Next at the bottom, the edit / report line at the end of the content,
- tooltips on abbreviations such as RTI, RCB or CAN anywhere in the text.
Found a mistake on this page? Edit it on GitHub · Report it · Get help