Extra Utilities Proposal

[Bamieh]

Doctoc for sure is a nice tool, however, i'd love if it had a utilities options, described in this tiny proposal, i'm willing to submit a pull request with the features of you guys find it suitable for doctoc and useful enough.

Feature

• back to top link to scroll back to top of the page.

  Back to top button

inside markdown file

# Table of contents
....
<!-- START doctoc:back-to-top -->
<!-- End doctoc:back-to-top -->

generated markdown:

# Table of contents
....
<!-- START doctoc:back-to-top -->
**[:up: Back to top](#table-of-contents)**
<!-- End doctoc:back-to-top -->

How it works

• Back to top captures the first heading in the page, and links to it. if the TOC has a heading in the title, link to the TOC regardless of its position.
• Add command line option --back-to-top ":up: Back to top" which accepts the title of the link.
• Doctoc matches for <!-- START doctoc(space " "/or dash "-") instead of <!-- START doctoc. this way adding : afterwards, doctoc will realize its calling a utility.

  Why utilities?

Utilities allow doctoc to be more expandable, allowing it to add markdown navigation in the future or such.

[strdr4605]

I created a tool that solves this problem: https://github.com/strdr4605/jump2header Maybe you can add a section to README that shows users how to use jump2header with doctoc. But first, we should make sure that tools are compatible.