Skip to content

Automatically generate table of contents in jekyll

License

Notifications You must be signed in to change notification settings

tyehle/toc-generation

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Table of Contents Generation

Automatically generate a table of contents in Jekyll.

See an example page.

Read about the details.

To Use

Add

  • _includes/toc.html
  • js/toc.js
  • js/jquery-3.1.1.slim.min.js (optional)

to your site.

Generate a toc for your page with

{% include toc.html %}

Options

  • tags: Specify which tags to generate links for. eg: {% include toc.html tags="H2,H3" %}
  • ignore: Ignore any tag matched by a jQuery selector. eg: {% include toc.html ignore="#sections" %}

About

Automatically generate table of contents in jekyll

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published