npmpackage.info

Gathering detailed insights and metrics for @zkochan/remark-toc

@zkochan/remark-toc - 0.2.0 | npmpackage.info

@zkochan/remark-toc

plugin to generate a table of contents (TOC)

0.2.0

464

MIT

JavaScript

5.03 kB

2,840 4.1

Installations

npm install @zkochan/remark-toc

Developer Guide

BETA

Typescript

No

Module System

N/A

Min. Node Version

>=0.10.0

Node Version

5.11.0

NPM Version

3.8.1 Score

70.9

Supply Chain

98.3

Quality

74.9

Maintenance

100

Vulnerability

100

License

Pull Requests

Open

0

Total

14

Closed

6

Merged

8

Issues

Open

0

Total

26

Closed

26

Releases

9.0.0

Updated on Sep 20, 2023

8.0.1

Updated on Oct 28, 2021

8.0.0

Updated on Aug 06, 2021

7.2.0

Updated on Feb 22, 2021

7.1.0

Updated on Feb 05, 2021

7.0.0

Updated on Jan 19, 2020

View All 20 releases

Languages

JavaScript

JavaScript (100%)

Developer

wooorm

Download Statistics

Total Downloads

2,840

Last Day

Last Week

Last Month

Last Year

402

GitHub Statistics

MIT License

464 Stars

198 Commits

33 Forks

13 Watchers

1 Branches

18 Contributors

Updated on Jun 30, 2025

Bundle Size

12.68 kB

Minified

5.03 kB

Minified + Gzipped

Bundlephobia

Maintainers

View All 18 Contributors

Package Meta Information

Latest Version

0.2.0

Package Id

@zkochan/remark-toc@0.2.0

Size

6.21 kB

NPM Version

3.8.1

Node Version

5.11.0

Total Downloads

Cumulative downloads

Total Downloads

2,840

Last Day

Compared to previous day

Last Week

300%

Compared to previous week

Last Month

-50%

Compared to previous month

Last Year

13.2%

402

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dependencies

remark-slug

Dev Dependencies

@zkochan/remark browserify eslint esmangle istanbul jscs jscs-jsdoc remark-comment-config remark-github remark-lint remark-usage remark-validate-links tape

remark-toc

Generate a Table of Contents in remark.

Installation

npm:

1npm install remark-toc

remark-toc is also available as an AMD, CommonJS, and globals module, uncompressed and compressed.

Usage

Dependencies:

1var remark = require('remark');
2var toc = require('remark-toc');

Process:

1var doc = remark().use(toc).process([
2    '# Alpha',
3    '',
4    '## Table of Contents',
5    '',
6    '## Bravo',
7    '',
8    '### Charlie',
9    '',
10    '## Delta',
11    ''
12].join('\n'));

Yields:

1# Alpha
2
3## Table of Contents
4
5-   [Bravo](#bravo)
6
7    -   [Charlie](#charlie)
8
9-   [Delta](#delta)
10
11## Bravo
12
13### Charlie
14
15## Delta

API

`remark.use(toc[, options])`

Add a Table of Contents to a Markdown document.

Looks for the first heading containing "Table of Contents", "toc", or table-of-contents (case insensitive, supports alt/title attributes for links and images too);
Removes all following contents until an equal or higher heading is found;
Inserts a list representation of the hierarchy of following headings;
Adds links to following headings, using the same slugs as GitHub.

Options (Object, optional):

slug — Passed to remark-slug;
heading (string?, default: "toc|table[ -]of[ -]contents?") — Heading to look for, wrapped in new RegExp('^(' + value + ')$', 'i');;
maxDepth (number?, default: 6) — Maximum heading depth to include in the table of contents, This is inclusive, thus, when set to 3, level three headings, are included (those with three hashes, ###);
tight (boolean?, default: false) — Whether to compile list-items tightly.

License

No vulnerabilities found.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

10

License

Determines if the project has defined a license.

10

Security-Policy

Determines if the project has published a security policy.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Fuzzing

Determines if the project uses fuzzing.

0

Branch-Protection

Determines if the default and release branches are protected with GitHub's branch protection settings.

0

SAST

Determines if the project uses static code analysis.

Score

4.1

/10

Last Scanned on 2025-06-23

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More