https://github.com/idyll-lang/idyll-plugin-table-of-contents

Table of contents plugin
https://github.com/idyll-lang/idyll-plugin-table-of-contents

Last synced: 14 days ago
JSON representation

Table of contents plugin

• Host: GitHub
• URL: https://github.com/idyll-lang/idyll-plugin-table-of-contents
• Owner: idyll-lang
• License: mit
• Created: 2018-11-10T02:21:23.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2019-03-12T03:16:53.000Z (over 5 years ago)
• Last Synced: 2024-10-30T00:54:57.766Z (21 days ago)
• Language: JavaScript
• Size: 553 KB
• Stars: 0
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Table of Contents plugin

## Installation

```

$ npm install --save-dev idyll-plugin-table-of-contents

```

Add it to your idyll configuration in `package.json`:

```json

"idyll": {

  "compiler": {

    "postProcessors": ["idyll-plugin-table-of-contents"]

  }

}

```

## Usage

To use the plugin place `[TableOfContents /]` where you want the table of contents to appear in your document. 

This plugin uses section headers to determine section heirarchy on your page.