Skip to content

Commit

Permalink
Updates README
Browse files Browse the repository at this point in the history
  • Loading branch information
Martin Lissmyr committed Jun 30, 2018
1 parent c5afd5f commit c54cd26
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ Name | Description
------------------|-------------------------------------------------------------------------------------|------------------------------------
"includeLevel" | Headings levels to use (2 for h2:s etc) | [1, 2]
"containerClass" | The class for the container DIV | "table-of-contents"
"slugify" | A custom slugification function | [string.js' `slugify`][slugify]
"slugify" | A custom slugification function | `encodeURIComponent(String(s).trim().toLowerCase().replace(/\s+/g, '-'))`
"markerPattern" | Regex pattern of the marker to be replaced with TOC | `/^\[\[toc\]\]/im`
"listType" | Type of list (`ul` for unordered, `ol` for ordered) | `ul`
"format" | A function for formatting headings (see below) | `undefined`
Expand All @@ -77,5 +77,3 @@ function format(headingAsString) {
return manipulatedHeadingString;
}
```

[slugify]: http://stringjs.com/#methods/slugify

0 comments on commit c54cd26

Please sign in to comment.