bubkoo / Hexo Toc
Licence: mit
📖 Insert a markdown TOC before posts be rendered.
Stars: ✭ 106
Programming Languages
javascript
184084 projects - #8 most used programming language
Projects that are alternatives of or similar to Hexo Toc
Hexoplusplus
🎁基于CloudFlareWorker的无服务器Hexo后端,目标:解决静态博客所有痛点[文章编辑、图片上传、博主活跃信息统计、博主说说、Twikoo加强版、阅读量统计【尚未完成】]
Stars: ✭ 72 (-32.08%)
Mutual labels: hexo
Farbox Theme Anatole
This theme is desiged for FarBox,You can use it directly or modified it on FarBox
Stars: ✭ 99 (-6.6%)
Mutual labels: hexo
Hexo Theme Webstack
A hexo theme based on webstack. | 一个基于webstack的hexo主题。
Stars: ✭ 86 (-18.87%)
Mutual labels: hexo
Hexo Theme Material
a theme of hexo using the material design bootstrap
Stars: ✭ 93 (-12.26%)
Mutual labels: hexo
Hexo Hide Posts
A plugin to hide specific posts from your Hexo blog and make them only accessible by links. (隐藏 Hexo 文章)
Stars: ✭ 93 (-12.26%)
Mutual labels: hexo
Hexo Theme Paperbox
A responsive paper-like theme for hexo blog.
Stars: ✭ 76 (-28.3%)
Mutual labels: hexo
Markdown Toc
Generate a markdown TOC (table of contents) for a README or any markdown files, using remarkable. Used by assemble, verb, and lots of other projects on GitHub. API and CLI.
Stars: ✭ 1,185 (+1017.92%)
Mutual labels: toc
Hexo Theme Melody
🎹A simple & beautiful & fast theme for Hexo.
Stars: ✭ 1,306 (+1132.08%)
Mutual labels: hexo
Hexo Theme Doku
📜 Doku, a Hexo theme designed for writing documents.
Stars: ✭ 101 (-4.72%)
Mutual labels: hexo
Hexo Symbols Count Time
Symbols count and time to read of articles for Hexo.
Stars: ✭ 93 (-12.26%)
Mutual labels: hexo
hexo-toc
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
decodeEntities: false
anchor:
position: after
symbol: '#'
style: header-anchor
-
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. -
decodeEntities
: Select whether to enable decode entities. ( Default isfalse
and please see #15). -
anchor
: Whether should have an anchor for each headings. (Default isfalse
)-
position
: Where should the anchor be,before
the title, orafter
the title. (Default isafter
); -
symbol
: Which symbol you want the anchor be. (Default is#
); -
style
: The CSS class for the anchor, (Default isheader-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
- hexo-filter-fenced-code Extend syntax for the native fenced code block.
- hexo-filter-flowchart Generate flowchart diagrams for Hexo.
- hexo-filter-sequence Generate UML sequence diagrams for Hexo.
-
hexo-filter-sub Generate subscript (
<sub>
) tag for Hexo. -
hexo-filter-sup Generate superscript (
<sup>
) tag for Hexo. - hexo-theme-formula Hexo theme base on jade and less.
Contributing
Pull requests and stars are highly welcome.
For bugs and feature requests, please create an issue.
Note that the project description data, including the texts, logos, images, and/or trademarks,
for each open source project belongs to its rightful owner.
If you wish to add or remove any projects, please contact us at [email protected].