remark-extract-toc

remark plugin to store table of contents

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
remark-extract-toc
681.1.04 years ago4 years agoMinified + gzip package size for remark-extract-toc in KB

Readme

remark-extract-toc
npm version check
remark plugin to store table of contents.
This plugin extracts only Heading from mdast markdown, then converts them to a nested object tree keeping the depth.
Install
npm install remark-extract-toc
Usage
var unified = require("unified");
var markdown = require("remark-parse");
var extractToc = require("remark-extract-toc");

var fs = require("fs");
var text = fs.readFileSync("example.md", "utf8");

var processor = unified().use(markdown).use(extractToc);

var node = processor.parse(text);
var tree = processor.runSync(node);
console.log(tree);

This example.md
# Alpha

aaaa

## Bravo

bbbb

### Charlie

cccc

## Delta

dddd

will be converted by this library like...
[
  {
    depth: 1,
    value: "Alpha",
    children: [
      {
        depth: 2,
        value: "Bravo",
        children: [{ depth: 3, value: "Charlie", children: [] }],
      },
      {
        depth: 2,
        value: "Delta",
        children: [],
      },
    ],
  },
]
API
remark().use(toc[, options])

Options

| Key | Default | Type | Description | | ------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------- | | flatten | false | boolean | If true, toc is extracted as a list not nested. | | keys | | string | Add extra field to tree object. For example, use remark-slug to add id and set { keys: ["data"] }. |
License
MIT