Guides
Filters
Filters transform template values before Markdown parsing. Nizel includes built-in filters from @sil/format and @sil/case.
Case Filters
From @sil/case:
| Filter | Input | Output |
|---|---|---|
camel | hello world | helloWorld |
capital | hello world | Hello world |
constant | hello world | HELLO_WORLD |
dot | hello world | hello.world |
header | hello world | Hello-World |
kebab | hello world | hello-world |
lower | Hello World | hello world |
pascal | hello world | HelloWorld |
path | hello world | hello/world |
sentence | hello world | Hello world |
snake | hello world | hello_world |
title | hello world | Hello World |
upper | hello world | HELLO WORLD |
Format Filters
From @sil/format:
| Filter | Usage | Description |
|---|---|---|
format | format('currency', 'EUR') | Format a number as currency |
format | format('date', 'dd MMM yyyy') | Format a date string |
format | format('number', '0.00') | Format a number with pattern |
Usage
---
title: ""
slug: ""
---
# {{ meta.title }}
Price: €0.00
Date: NaN January,February,March,April,May,June,July,August,September,October,November,December NaN
Status:
Chaining
Filters can be chained:
Guides
More Pages
-
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. -
Frontmatter
Nizel extracts a leading frontmatter block before template rendering and Markdown parsing.
-
Table of Contents
Nizel collects headings into
result.tocwhentoc: trueis 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.
-
NizelKit for Native Apps
nizel-kitis the browser/WebView bundle for native apps that want Nizel rendering with user-selectable plugins. -
Presets
Nizel exposes built-in option bundles for common use cases.
-
Styling
nizel-styleships scoped CSS for rendered Markdown content and official Nizel plugin output. -
Nizel Format
nizel-formatformats Markdown source text. Use it when an app needs consistent Markdown before saving, syncing, or rendering. -
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
Per-plugin overhead can be measured with:
-
HTML to Markdown
Nizel exposes
htmlToMarkdown(html, options)for importing semantic HTML into Markdown.