1.0.5 • Published 7 years ago
hexo-toc-ext v1.0.5
hexo-toc-ext
Added chapter format to hexo-toc.
Image
- indent: false
- indent: true
- firstHeaderTagSkip: true
Install
npm install hexo-toc-ext --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
indent: true # default(true)
firstHeaderTagSkip: false # default(false)
anchor:
contents:
style: contents-header
heading:
style: header-anchor
notIncludeHeading: false # default(false)
maxdepth
: Use headings whose depth is at most maxdepth.class
: The CSS Class for the toc. (Default isfalse
)slugify
: Choose which slugify function you want to use. Currently support uslug (Default) and transliteration.indent
: add indent(Default istrue
)firstHeaderTagSkip
: delete first header(Default isfalse
)anchor
: Whether should have an anchor for each headings. (Default isfalse
)contents
:style
: The CSS class for the anchor, (Default iscontents-anchor
);
heading
:style
: The CSS class for the anchor, (Default isheader-anchor
);notIncludeHeading
: Do not include header in link, (Default isfalse
);
Contributing
Pull requests and stars are highly welcome. For bugs and feature requests, please create an issue.