Documentation
These pages are the repository's own Markdown files, rendered at build time by
mdlib-pure itself with gfm(), headings({ permalink: true }) (ids,
permalinks and the table of contents from toc()), math(),
container(), deflist() and mark(). Links between the files point to
these pages; other repository paths link to GitHub. Every guide of the
repository (docs/*.md, bindings/*/README.md) has a page here: the site
build fails if one is missing.
| Page | Source | Covers |
|---|---|---|
| Getting started | README.md |
install, usage, options, highlighting, frameworks, styling, plugins, performance |
| API reference | docs/api.md |
createMarkdown(), options, methods, AST shape, rendering helpers, every plugin |
| Web Components | docs/elements.md |
<mdlib-markdown> and <mdlib-editor> (mdlib-pure/element): attributes, loaders, named configs, events, form value, frameworks that rewrite the page |
| Blazor | bindings/blazor/README.md |
MdlibPure.Blazor for .NET 10: Markdown editor, viewer, AST service, podcast editor with typed episode binding (0.1.1) |
| Angular | bindings/angular/README.md |
ngx-mdlib-pure 0.2.0 for Angular 21 and 22: <mdlib-editor [(value)]> (a form control too), <mdlib-markdown>, provideMdlibPure(), MarkdownService, SSR with hydration; ngx-mdlib-pure/podcast adds the podcast editor |
| Design tokens | docs/tokens.md |
the --md-* tokens of theme.css, light and dark, Tailwind CSS v4 |
| Custom plugin: podcast | docs/podcast.md |
a copyable custom plugin with a split editor, participant completion, planned section durations and linked documents |
| Security | docs/security.md |
what is guaranteed by default, raw HTML, URL policy, DOM clobbering |
| Extending: plugin guide | AGENTS.md |
AGENTS.md: rules, how parsing works, recipes for every extension point |
| Changelog | CHANGELOG.md |
notable changes in each version |
For AI agents
Read /llms.txt for an index of the Markdown version of every
page, or /llms-full.txt for all the docs in one file.
AGENTS.md is the contract for extending the library.
More in For AI agents.