πŸ“– Insert a markdown TOC before posts be rendered.
JavaScript
Latest commit 3a7a6e2 Jan 10, 2017 @bubkoo fix config error
Permalink
Failed to load latest commit information.
lib fix config error Jan 10, 2017
.editorconfig .editorconfig Sep 9, 2015
.gitignore Initial commit Apr 19, 2015
.jshintrc v1.0.0 Apr 16, 2016
.npmignore npmignore Sep 9, 2015
LICENSE Initial commit Apr 19, 2015
README.md v1.0.6 Jan 9, 2017
index.js fix config error Jan 10, 2017
package.json fix config error Jan 10, 2017

README.md

hexo-toc

MIT License

npm: Package Quality

Insert a markdown TOC(Table Of Content) before posts be rendered.

Unlike the native toc helper, this plugin will inject a TOC only when a placeholder(<!-- toc -->) found in the raw markdown files. And the TOC will be injected after the placeholder.

All you need to do is placing a placeholder(<!-- toc -->) in your post when and where needed.

Note: this plugin will not mangle your posts(markdown files), so you can use it bold.

Install

npm install hexo-toc --save

Options

All the options of markdown-toc, slugify function, and heading anchor options can be specified as follow in you _config.yml:

toc:
  maxdepth: 3
  class: toc
  slugify: transliteration
  anchor:
    position: after
    symbol: '#'
    style: header-anchor
  • maxdepth: Use headings whose depth is at most maxdepth.
  • class: The CSS Class for the toc. (Default is false)
  • slugify: Choose which slugify function you want to use. Currently support uslug (Default) and transliteration.
  • anchor: Whether should have an anchor for each headings. (Default is false)
    • position: Where should the anchor be, before the title, or after the title. (Default is after);
    • symbol: Which symbol you want the anchor be. (Default is #);
    • style: The CSS class for the anchor, (Default is header-anchor);

Known issues

#8

Working with hexo-renderer-markdown-it.

# Markdown-it config
## Docs: https://github.com/celsomiranda/hexo-renderer-markdown-it/wiki
markdown:
  render:
    html: true

Related

Contributing

Pull requests and stars are highly welcome.

For bugs and feature requests, please create an issue.