Suppport auto generating toc content for the [TOC] tag

[hikerpig]

Description

This PR add a markdown-it plugin to support auto generating content for [TOC] or [toc] tag.

This feature was implemented in many Markdown editors, (Typora, Haroopad, MWeb, etc.).

Although there is already a command 'Generate/Update Markdown TOC' in Boostnote, but I think these two serve for different purposes, so they can both exist.

The demo goes:

Issue fixed

• [TOC] tag support #3022

Type of changes

• 🔘 Feature (Change that adds new functionality)

Checklist:

• 🔘 My code follows the project code style
• 🔘 I have written test for my code and it has been tested
• 🔘 All existing tests have been passed
• 🔘 I have attached a screenshot/video to visualize my change if possible

---

IssueHunt Summary

Referenced issues

This pull request has been submitted to:

• #3022: [TOC] tag support

---

IssueHunt has been backed by the following sponsors. Become a sponsor

[ZeroX-DG]

@hikerpig thanks for the cool PR, can you add a setting to disable this feature? Some people may not need auto generated toc

[hikerpig]

@ZeroX-DG I don't see your worry here, maybe I misunderstand it.

Let's assume if someone typed this [TOC] placeholder - which is not a common word - manually, the expected behavior should be auto generating content.

Say if there is a config and it is turned off, what is the expected behavior for the placholder?

[ZeroX-DG]

@hikerpig You can totally ignore my comment, I didn't see the [toc] tag. My brain sometimes is on autopilot 😄

[hikerpig]

Code review could be exhausting sometimes 😆 , thank you for your work.

Let me know if there is anything else that needs to be updated.

[amedora]

looks nice.

However we should remove current implementation of TOC feature before add this new one.

[ZeroX-DG]

@amedora can you share your thought on this? Why can't they both exist?

[ZeroX-DG]

@hikerpig it seem that your markdownItTocAndAnchor lib doesn't support heading with uppercase letter. Can you fix it please?

[amedora]

@ZeroX-DG ,Technically both can exist together.
However, it's questionable to have two implementations for that almost same feature...(is it worth to maintain both codes?)

[ZeroX-DG]

@amedora I think we should also keep the old TOC too, because user will have more control/customization of the TOC with the old feature.

[amedora]

@ZeroX-DG, I see. Thank you for your clarification 👍

[ZeroX-DG]

@hikerpig ping!

[hikerpig]

@Flexo013 What needs to be changed? Should I add anything ?

[Flexo013]

There was this comment by Zero:

@hikerpig it seem that your markdownItTocAndAnchor lib doesn't support heading with uppercase letter. Can you fix it please?

[hikerpig]

@ZeroX-DG I can't reproduce the bug what you described with heading with uppercase letter.

Can you be more specific? Give me some example content so I can improve against. 😃

[ZeroX-DG]

@hikerpig Here is a small example:

As you can see, the id of the actual heading has uppercase letter while in the link it automatically lowercase everything, this make the link not navigate to the heading.

[hikerpig]

@ZeroX-DG Oh I see, I will fix this in 48h.

[hikerpig]

@ZeroX-DG I've updated the package to fix this annoying lowercase-casting thing.

[ZeroX-DG]

LGTM 🎉

[Rokt33r]

@hikerpig I want to merge this very soon. Could you fix the conflicts?

[Rokt33r]

@hikerpig Could you fix CI error too? I think updating snapshot should be enough! Check https://travis-ci.org/BoostIO/Boostnote/builds/596037299#L394

[hikerpig]

Error fixed.

BTW, I suggest that the npm 'test' script should contain jest tests.

[Rokt33r]

@hikerpig Thanks! ❤️