materialx-bookmarks

This site is the live demo for materialx-bookmarks, a bookmark component for mkdocs-materialx. Every list below is built from a YAML file in this repository.

What it does

Bookmarks are written as YAML, validated when the site builds, and rendered in the browser with search, tag filtering, sorting and pagination. State lives in the URL, so any view you are looking at can be linked to.

A bookmark can point at several places — documentation, source, a changelog — each one a labelled button beneath its description.

Install

pip install materialx-bookmarks

The package is on PyPI; setup and the full option reference live in the README.

A component in the middle of a page

The block below sits between two paragraphs of ordinary Markdown — the component is not a special page type, it goes wherever you put the fence.

Everything after the component is normal page content again. Try a search, combine two tags, or switch the sort order and watch the address bar.

Where to go next

• Tools — the same collection on a page of its own
• Reading — blogs, six per page
• Learning — documentation, specs and books, including one entry with no links
• Two on one page — two independent components side by side