1.1.3 • Published 1 year ago

@dllcnx/hexo-toc v1.1.3

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

hexo-toc-dllcn

hexo-toc的修改版,防止和next的侧边栏导航冲突,删除了部分配置.

默认以# ## 等标题作为锚点,但是有一个问题,标题不能存在特殊字符,-,_,~除外。

Install

npm install hexo-toc-dllcn --save

USE

在md文章内加入以下标识符即可。

<!-- toc -->

Options

mdtoc:
  maxdepth: 3
  class: toc
  decodeEntities: false
  anchor:
    symbol: '#'
    style: header-anchor
  • maxdepth: Use headings whose depth is at most maxdepth.
  • class: The CSS Class for the toc. (Default is false)
  • decodeEntities: Select whether to enable decode entities. ( Default is false and please see #15).
  • anchor: Whether should have an anchor for each headings. (Default is false)
    • symbol: Which symbol you want the anchor be. (Default is #);
    • style: The CSS class for the anchor, (Default is header-anchor);