Need private packages and team management tools?Check out npm Teams »

markdown-contents

1.0.11 • Public • Published

Markdown Contents

Travis build status Coveralls NPM version Canonical Code Style Twitter Follow

Generate table of contents for a markdown document.

The underlying implementation is rendering markdown file into HTML and then use Contents. to generate the table of contents.

Usage

import MarkdownContents from 'markdown-contents';
 
const markdown = '';
const markdownContents = MarkdownContents(markdown);
 
/**
 * Generate flat index of the headings.
 *
 * @return {Array} 
 */
markdownContents.articles();
 
/**
 * Generates hierarchical index of the headings from a flat index.
 *
 * @return {Array} 
 */
markdownContents.tree();
 
/**
 * Generate markdown for the table of contents.
 *
 * @return {string} 
 */
markdownContents.markdown();
 
/**
 * Generate markdown contents for an array of contents object definition.
 *
 * @param {Array} tree [{id: '', name: '', descendants: []}]
 * @return {string} markdown
 */
MarkdownContents.treeToMarkdown();
 
/**
 * Makes hierarchical index of the articles from a flat index.
 *
 * @param {Array} articles Generated using Contents.articles.
 * @param {boolean} makeUniqueIDs 
 * @param {Array} uniqueIDpool 
 * @return {Array} 
 */
MarkdownContents.tree();
 

Install

npm i markdown-contents

DownloadsWeekly Downloads

1,314

Version

1.0.11

License

BSD-3-Clause

Unpacked Size

10.1 kB

Total Files

6

Last publish

Collaborators

  • avatar