# mdlib-pure

> Lightweight, zero-dependency Markdown renderer for the browser: 100% CommonMark 0.31.2 (652/652 spec examples), GitHub Flavored Markdown as an opt-in plugin (54/54 extension examples), an ~11 KB gzipped core, safe by default, linear time on any input. Extensible through plugins, styled with semantic CSS tokens, output as HTML, DOM, React/Preact/Vue elements, or the <mdlib-markdown> and <mdlib-editor> Web Components, which the MdlibPure.Blazor (.NET 10) and ngx-mdlib-pure (Angular) wrappers build on. Not on a package registry yet (no npm, no NuGet): the Install section of each guide says how to install it today.

Every page of this site has a Markdown version at the same path with `.md`; the docs are the repository's own Markdown files. To extend the library, read AGENTS.md ("Extending: plugin guide") fully first: it is the contract for AI agents, and `npm run verify` must pass before a task is done. To use it in a page or an app, the guides are docs/elements.md (Web Components), bindings/blazor/README.md (Blazor) and bindings/angular/README.md (Angular). Nothing is published on npm or NuGet yet: never suggest `npm install mdlib-pure`; README.md (Install) gives the tarball URL on the GitHub release.

## Docs

- [Getting started](https://michelepolo.github.io/mdlib-pure/docs/getting-started.md): install, usage, options, highlighting, frameworks, styling, plugins, performance
- [API reference](https://michelepolo.github.io/mdlib-pure/docs/api.md): createMarkdown(), options, methods, AST shape, rendering helpers, every plugin
- [Web Components](https://michelepolo.github.io/mdlib-pure/docs/elements.md): <mdlib-markdown> and <mdlib-editor> (mdlib-pure/element): attributes, loaders, named configs, events, form value, frameworks that rewrite the page
- [Blazor](https://michelepolo.github.io/mdlib-pure/docs/blazor.md): MdlibPure.Blazor for .NET 10: Markdown editor, viewer, AST service, podcast editor with typed episode binding (0.1.1)
- [Angular](https://michelepolo.github.io/mdlib-pure/docs/angular.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](https://michelepolo.github.io/mdlib-pure/docs/tokens.md): the --md-* tokens of theme.css, light and dark, Tailwind CSS v4
- [Custom plugin: podcast](https://michelepolo.github.io/mdlib-pure/docs/podcast.md): a copyable custom plugin with a split editor, participant completion, planned section durations and linked documents
- [Security](https://michelepolo.github.io/mdlib-pure/docs/security.md): what is guaranteed by default, raw HTML, URL policy, DOM clobbering
- [Extending: plugin guide](https://michelepolo.github.io/mdlib-pure/docs/extending.md): AGENTS.md: rules, how parsing works, recipes for every extension point
- [For AI agents](https://michelepolo.github.io/mdlib-pure/docs/agents.md): llms.txt, Markdown twins, AGENTS.md as the contract, how to ask for a plugin, the guides for using it in an app

## Examples

- [Samples](https://michelepolo.github.io/mdlib-pure/samples.md): Markdown source and rendered output for CommonMark, GFM, math, Mermaid, definition lists, containers, mark, front matter, syntax highlighting, Tailwind classes and React, and a live <mdlib-editor> and <mdlib-markdown>
- [Plugins](https://michelepolo.github.io/mdlib-pure/plugins.md): import path, gzip size, syntax and AST nodes of every first-party plugin, and the size of mdlib-pure/element
- [Playground](https://michelepolo.github.io/mdlib-pure/playground.md): the live editor and what it can do
- [Podcast rundown](https://michelepolo.github.io/mdlib-pure/podcast.md): a complete custom-plugin sample: split editor, participant completion, planned durations and supporting documents

## Optional

- [Changelog](https://michelepolo.github.io/mdlib-pure/docs/changelog.md): notable changes in each version
- [mdlib-pure 0.1.1 release](https://github.com/MichelePolo/mdlib-pure/releases/tag/mdlib-pure-v0.1.1): the npm tarball (not on the npm registry)
- [ngx-mdlib-pure 0.2.0 release](https://github.com/MichelePolo/mdlib-pure/releases/tag/angular-v0.2.0): the npm tarball of the Angular wrapper (not on the npm registry)
- [MdlibPure.Blazor 0.2.0 release](https://github.com/MichelePolo/mdlib-pure/releases/tag/blazor-v0.2.0): the .nupkg of the Blazor wrapper (not on nuget.org)
- [Built with AI](https://michelepolo.github.io/mdlib-pure/story.md): how the library was built with AI agents, from the git history
- [Home](https://michelepolo.github.io/mdlib-pure/index.md): overview, ways to use it (JavaScript, Web Components, React/Preact/Vue, Blazor, Angular), datasheet and benchmark
- [All docs in one file](https://michelepolo.github.io/mdlib-pure/llms-full.txt)
- [Source repository](https://github.com/MichelePolo/mdlib-pure): README.md, AGENTS.md, docs/, src/, templates/plugin, bindings/blazor, bindings/angular