Add support for alternative URL in TOC #10
Conversation
_includes/toc.html
Outdated
| @@ -19,6 +19,7 @@ | |||
| * h_max (int) : 6 - the maximum TOC header level to use; any header greater than this value will be ignored | |||
| * ordered (bool) : false - when set to true, an ordered list will be outputted instead of an unordered list | |||
| * item_class (string) : '' - add custom class for each list item; has support for '%level%' placeholder, which is the current heading level | |||
| * base_url (string) : '' - Possible to add links to other domains | |||
There was a problem hiding this comment.
For consistency, could you remove the extra space before the (string) so everything can be lined up and make Possible lowercase to match the others?
Additionally, could you also add this new parameter to the README?
|
I really like this! I had never thought about creating a "summary" page of TOCs for other pages. |
|
Fixed the formatting and the documentation. Does the description of the parameter look okay? I'm a bit short on good words right now 😄 |
|
Tagged as 1.0.5. Thanks for this! 🎉 |
|
By looking at it, doesn't the docs say |
|
Yup! Oversight on my part when I was reviewing the PR, it's been fixed in f98fc33. The current master branch and 1.0.5 tag have the correct documentation. |
Sometimes it is useful to be able to point the TOC to a new page. For example in an overview of meeting minutes found here:
https://fordelingsutvalget.org/archive/
https://github.com/cybernetisk/fordelingsutvalget/blob/master/blog/archive.html
These minutes then point to an alternative page like for example:
https://fordelingsutvalget.org/posts/2018/2018-05-16-Fjerde_M%C3%B8te/#agenda
This does not affect anything other than the href field. And does not break on any valid href.