Guides

Presets

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

Available Presets

blog

Optimized for blog content:

const nizel = useNizel({ preset: 'blog' });
// frontmatter: true
// toc: true
// anchors: true
// excerpt: 160 characters
// readingTime: true

docs

Optimized for documentation:

const nizel = useNizel({ preset: 'docs' });
// frontmatter: true
// toc: true
// anchors: true
// slugStyle: 'github'

email

Optimized for email HTML:

const nizel = useNizel({ preset: 'email' });
// safe: true
// inlineStyles: true
// elements: table-based layout

minimal

Minimal processing, no extras:

const nizel = useNizel({ preset: 'minimal' });
// frontmatter: false
// toc: false
// anchors: false

Override Preset Options

Presets set defaults. You can override individual options:

const nizel = useNizel({
  preset: 'blog',
  toc: false, // disable TOC from the blog preset
});