jekyll-table-of-contents

A simple JavaScript table of contents generator. Works well with jekyll static sites.

Usage

Basic Usage

The script requires jQuery. First, reference toc.js in templates where you would like to add the table of content. Then, create an HTML element wherever you want your table of contents to appear:

<div id="toc"></div>

Finally, call the .toc() function when the DOM is ready:

<script type="text/javascript">
$(document).ready(function() {
    $('#toc').toc();
});
</script>

If you use redcarpet, you need to have the option with_toc_data in order to add HTML anchors to each header:

markdown: redcarpet
redcarpet:
    extensions: [with_toc_data]

If you use rdiscount, enable the following option in order to generate the TOC:

markdown: rdiscount
rdiscount:
    extensions:
      - generate_toc

How It Works

The script works by looking for headers (h1, h2, h3, h4, h5, h6) which have an id. An id is added automatically if you're using Jekyll and Markdown.

The table of contents automatically handles nesting of headers. For example, this Markdown post:

## Title
## Page 1
### Note on Paragraph 3
## Page 2
### Note on Paragraph 2
### Note on Paragraph 4

Will render this table of contents:

1. Title
2. Page 1
  a. Note on Paragraph 3
3. Page 2
  a. Note on Paragraph 2
  b. Note on Paragraph 4

Configuration

List Type

By default the table of contents is rendered as an <ol>, so you can change the number formatting using CSS. However you can use the <ul> tag, using the listType option:

$('#toc').toc({ listType: 'ul' });

Header Styling

The script also adds an <i> tag next to each header. This uses the class icon-arrow-up, which if you're using Bootstrap, will be an arrow pointing to the top of the page. Clicking that arrow will scroll you to the top, while clicking on a header will get a permanent link to that particular header (using window.location.hash).

If you don't want this feature, add this setting:

$('#toc').toc({ noBackToTopLinks: true });

Otherwise, you can use the stylesheet below to have the icon and the header aligned nicely:

.clickable-header {
  cursor:pointer;
}
.clickable-header:hover {
  text-decoration:underline;
}
.top-level-header {
  display:inline;
}
.back-to-top {
  margin-left:5px;
  cursor:pointer;
}

Headers Used

By default the table of content is displayed when at least 3 headers are found. You can customize the minimum number of headers required with this setting:

$('#toc').toc({ minimumHeaders: 2 });

And you can also select which headers you want to link to. By default h1, h2, h3, h4, h5, h6 are displayed, but changing the headers setting lets you tweak it:

$('#toc').toc({ headers: 'h3, h4, h5, h6' });
$('#toc').toc({ headers: '.content h1, .content h2, .content h3, .content h4, .content h5, .content h6' });

Effects

Finally, you can also change the way the toc is displayed, choosing a slideShow or a fadeIn effect instead of show:

$('#toc').toc({ showEffect: 'slideDown' });

Otherwise, to deactivate the effect, set it up like this:

$('#toc').toc({ showSpeed: 0 });

List And Item Styling

You can specify additional CSS classes for both lists (<ul>, <ol>) and items (<li>):

$('#toc').toc({ classes: { list: 'lorem ipsum',
                           item: 'dolor sit amet'
                         }
              });

Copyright

See LICENSE.txt for further details. But basically, do what you like with this.

stas00 / jekyll-table-of-contents Goto Github PK