Skip to content
This repository has been archived by the owner on Mar 9, 2022. It is now read-only.

A markdown-it plugin for wrapping headings in arbitrary markup.

License

Notifications You must be signed in to change notification settings

mozilla/markdown-it-heading-wrapper

Repository files navigation

markdown-it-heading-wrapper

CircleCI

A plugin very much inspired by and based on markdown-it-header-sections, albeit in this case it's designed to allow for arbitrary markup wrappers rather than just a single section.

The idea behind this is to allow a document author to focus on pure documentation and to have the renderer add boilerplate markup to affect a specific layout.

Usage

  markdown = md({
    html: true,
  }).use(require('markdown-it-heading-wrapper'), {
    h1: {
      before: '<section>',
      after: '</section>',
    },
  });

About

A markdown-it plugin for wrapping headings in arbitrary markup.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 3

  •  
  •  
  •