Guides

Everything you need to use Nizel effectively.

Start with Getting Started if you are new. Use the sidebar to navigate to specific topics.

Getting Started

The main call returns a structured object:
API Reference

Creates a Nizel processor instance.
Result Object

Nizel returns a structured result object from every parse call.
Pipeline

Nizel processes content in a predictable order.
Template Variables

Nizel supports variable injection before Markdown parsing. Use {{ expression }} syntax in both frontmatter and body content.
Filters

Filters transform template values before Markdown parsing. Nizel includes built-in filters from @sil/format and @sil/case.
Frontmatter

Nizel extracts a leading frontmatter block before template rendering and Markdown parsing.
Table of Contents

Nizel collects headings into result.toc when toc: true is set.
Elements

Elements control how HTML is generated from the AST. You can customize tag names, attributes, and classes for any element type.
Plugins

Plugins bundle functionality into reusable extensions that hook into the Nizel pipeline.
Presets

Nizel exposes built-in option bundles for common use cases.
Safety

Safe output is enabled by default in Nizel.
Testing

Nizel’s test suite protects the Markdown behavior documented for the package.
Transforms

Transforms receive the normalized AST after parsing and before rendering. They let you modify the content tree programmatically.
Benchmarks

Nizel keeps two benchmark reports: an engine comparison against other Markdown parsers and an internal function benchmark for finding parser, renderer, and pipeline bottlenecks.
HTML to Markdown

Nizel exposes htmlToMarkdown(html, options) for importing semantic HTML into Markdown.