Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
iridescent-dev authored May 24, 2020
1 parent c138143 commit cf6e12b
Showing 1 changed file with 4 additions and 2 deletions.
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ Generate a table of contents for the pages of your [Pico](http://picocms.org) si
* Copy the `TableOfContents` folder into the `plugins` folder of your project.
* Update your theme to include CSS style.
* Define the configuration variables if default values are not suitable.
* Add `<toc />` in your content files where you want the table of contents to appear.
* Add `<toc />` element where you want the table of contents to appear on your page.

### Usage
In your content markdown files, simply add the `<toc />` element where you want the table of contents to be inserted.
Automatically generates a table of contents based on the elements `<h1>` to `<h6>` of your page.

In the `.md` file corresponding to your page, simply add the `<toc />` element where you want the table of contents to be inserted. The `<toc />` element must be added for each page you want.

### Update your theme
In your template files, add the plugin's CSS style in the `head` section:
Expand Down

0 comments on commit cf6e12b

Please sign in to comment.