Plugins
First-party Nizel plugins add focused behavior without changing the core content pipeline.
Install the packages you need, register them in useNizel({ plugins }), and keep plugin behavior explicit at the call site.
Available Plugins
- Abbreviations - Abbreviation definitions.
- Alerts - GitHub-style callout blocks.
- Autolinks - Bare URL and email link behavior.
- Badge - Inline badges and status labels.
- Citations - Simple citation references and bibliography.
- Code Copy - Copy controls for code blocks.
- Definition Lists - Definition-list Markdown syntax.
- Details - Disclosure blocks.
- Diagrams - Mermaid diagram containers.
- Emoji -
:name:emoji shortcuts outside code. - Footnotes - Footnote references and definitions.
- Frontmatter UI - Metadata rendering helpers.
- GFM Preset - GFM-oriented companion plugin preset.
- Heading Anchors - Visible heading anchor links.
- Hidden Comments - Controlled Markdown HTML comment rendering.
- Keyboard Shortcuts - Semantic keyboard shortcut markup.
- Math - Inline and display math wrappers.
- Media - Figure and image enhancements.
- Open Icon - Inline SVG icons from the local Open Icon catalog.
- Print - Print and PDF layout controls.
- Sanitize - Output sanitizing.
- Shiki - Worker-compatible syntax highlighting integration.
- Task Lists - View-only or editable task-list checkboxes.
- Table of Contents - Rendered
[[toc]]. - Typography - Mark, subscript, and superscript extensions.
For plugin authoring concepts and pipeline hook details, read the plugin guide.
-
Abbreviations
nizel-plugin-abbrrenders abbreviation definitions such as: -
Alerts
nizel-plugin-alertadds GitHub-style callout blocks for notes, tips, important notices, warnings, and cautions. -
Autolinks
nizel-plugin-autolinkconfigures Nizel's built-in conversion of bare URLs and email addresses into links. -
Badge
nizel-plugin-badgerenders compact inline labels with safe tones, aliases, titles, and metadata. -
Citations
nizel-plugin-citationsadds simple citation references and bibliography output. -
Code Copy
nizel-plugin-code-copyrenders copy controls for fenced code blocks. -
Definition Lists
nizel-plugin-deflistconverts definition-list syntax into<dl>,<dt>, and<dd>output. -
Details
nizel-plugin-detailsadds disclosure blocks: -
Diagrams
nizel-plugin-diagramsrenders Mermaid fences as containers for a host Mermaid renderer. -
Emoji
nizel-plugin-emojireplaces known:name:shortcuts with emoji before Markdown is parsed. -
Footnotes
nizel-plugin-footnotesrenders[^id]references and definitions. -
Frontmatter UI
nizel-plugin-frontmatter-uiprovides helpers for rendering metadata as UI. Core Nizel already parses frontmatter; this plugin is for display. -
GFM Preset
nizel-plugin-gfmis a convenience preset for GFM-oriented companion plugins. Core Nizel already includes GFM-like tables, task list metadata, strikethrough, and autolinks. -
Heading Anchors
nizel-plugin-heading-anchorsappends visible anchor links to headings with generated IDs. -
Hidden Comments
nizel-plugin-hidden-commentscontrols how Markdown HTML comments render. It can keep comments in the generated HTML for copy/PDF workflows, show them as small reviewer notes, render them inline, or remove them entirely. -
Keyboard Shortcuts
nizel-plugin-kbdrenders inline keyboard shortcuts as real<kbd>elements. -
Math
nizel-plugin-mathwraps inline$math$and display$$math for a host renderer such as KaTeX or MathJax. -
Media
nizel-plugin-mediaenhances standalone images by wrapping them in figures and adding native-friendly image attributes. -
Open Icon
nizel-plugin-open-iconrenders Open Icon SVGs from the installedopen-iconpackage. -
Print
nizel-plugin-printadds block directives for page breaks, print-only content, screen-only content, and page split control. -
Sanitize
nizel-plugin-sanitizeremoves risky HTML from rendered output. It is enabled by default innizel-kit. -
Shiki
nizel-plugin-shikilets Nizel delegate fenced code block rendering to a Worker-compatible highlighter function. -
Task Lists
nizel-plugin-task-listrenders parsed task-list items as checkbox markup. -
Table of Contents
nizel-plugin-tocrenders[[toc]]from document headings. -
Typography
nizel-plugin-typographyadds optional inline typography extensions: