TOC (Table of contents) helper

[tommy351]

Usage

<%- toc(str, [options]) %>

• str - Input string
• options - Options
  • class - Class name
  • list_number - Display list number

[tommy351]

commit: 3efb980

[wzpan]

Cool. Maybe add one more option:

• options - Options
  • class - Class name
  • list_number - Display list number
  • depth - the deepest heading level to be included.

[simonexmachina]

Can someone provide an example of how to use this?

[simonexmachina]

I'd like to be able to insert [toc] into my Markdown to display a TOC, which I can do using a filter, but how can I access this helper from my script?

[tommy351]

Put the following in the theme:

<%- toc(page.content) %>

And this helper will scan all headers in the content and generate a table of contents.

[fwz]

Hi, I am using Hexo 2.6.1 and landscape theme, and try to add a toc into my post.

Adding

<%- toc(page.content) %>

into themes/landscape/layout/_partial/article.ejs doesn't work. but adding

<%- toc(post.content) %>

shows the TOC.

However, there are extra numbers before each line of TOC.
I attach the HTML here: http://jsfiddle.net/de8a8/
Could anyone please take a look? how could I remove that number?

Thanks!

[NicholasTD07]

@fwz See this pull request.

[fwz]

@NicholasTD07
Thanks. Are you referring to 3efb980 ?

If so, is it possible to set the list_number as false by configuration?

[NicholasTD07]

@fwz Sorry, this one:

#780

[fwz]

@NicholasTD07

Thanks!

[yantze]

<%- toc(page.content, {list_number: false}) %>

[kuanyui]

Any way to use this like <!-- toc --> in article ? Because I tend to place the TOC at exactly where I want in different article.

I've tried to reuse tocHelper(), but cannot find a way to call the function... (Sorry, I'm not familiar with Node.js...):

hexo.extend.filter.register('post', function(data) {
    data.content = data.content.replace(/<!-{2,} *toc *-{2,}>/, hexo.plugins.helper.toc.tocHelper(data.content));
    return data;
});

[wzpan]

@kuanyui ,you can only call this helper in your theme template files(.ejs).

[kuanyui]

But I don't want to add the TOC at a fix position.
For example, sometimes I insert the TOC after preamble, sometimes before.

[wzpan]

If so, then don't use this helper. There are many other jQuery plugins that are more flexible and suitable for your demand e.g. http://fuelyourcoding.com/scripts/toc/

[JiantaoFu]

"<%- toc(page.content, {list_number: true}) %>" adding extra list number, and i can't remove it by {list_number: false}

{list_number: true}

[bubkoo]

@JiantaoFu set list-style:none in your css.

[BrunoHu]

Could toc function provide the depth option? I think this option could make the page more simple and eligant.

[bennycode]

I saw that the tocHelper is registered in the Hexo.js code with helper.register('toc', require('./toc'));. Is there any clean way to make use of this if you want to apply the tocHelper in your own code?

@kuanyui: Currently I am importing the tocHelper in the following way:

const tocHelper = require('hexo/lib/plugins/helper/toc');
const toc = tocHelper(html, { max_depth: 2 });