mrpotatoes / docsify-toc

docsify-toc

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Docsify Table of Contents


docsify-toc

Note: I won't be adding features but feel free to add pull requests and if they work/pass tests I'll add them in.

To use

Add stylesheet

<link rel="stylesheet" href="https://unpkg.com/docsify-toc@1.0.0/dist/toc.css">

Add JS

<script src="https://unpkg.com/docsify-toc@1.0.0/dist/toc.js"></script>

Add settings

window.$docsify = {
  toc: {
    scope: '.markdown-section',
    headings: 'h1, h2, h3, h4, h5, h6',
    title: 'Table of Contents',
  },
}

TODO

  • Tests
  • Example
  • Documentation

About

docsify-toc

License:MIT License