Add table of contents

[ma-shamshiri]

Proposed changes

I added a table of contents to make it easier to navigate README.md

Types of changes

• Bug fix (non-breaking change which fixes an issue)
• New feature (non-breaking change which adds functionality)
• Breaking change (fix or feature that would cause existing functionality to not work as expected)
• Documentation Update (if none of the other choices apply)

[alexgurr]

I like this idea, however have a few points:

• It seems this has broken a bunch of the headers -
• I'd rather keep the bullet points consistent symbols (•) and not bother with the arrows
• Not a big fan of the rainbow separator. Can we keep it consistent with the others?
• I'd put a   above the Table of Contents headers, to be consistent with other headers
• Emojis on headers go at the end of the header, not the start :)

[alexgurr]

Thanks for this. Will re-review in the morning and merge it if it's all ok.

[alexgurr]

• Slack icon next to the community header still missing

• Arrows are still showing in the table of contents (is there a way around this?)

[ma-shamshiri]

Thank you Alex for your comment.
I just added the Slack icon next to the community header.
Also, the arrows have been removed from the table of contents.

[alexgurr]

For some reason the first entry always shows an arrow

[ma-shamshiri]

Well, the reason the first arrow is displayed is that I used the "details" tag for the table of contents.
In this case, the user can open and close the table of contents.
Actually "details" tag is basically used to create an interactive widget that one can open and close.
Do you want me to remove it?

[alexgurr]

I don't think it needs to be closable, I think we can just make it static.

[ma-shamshiri]

That's right.
I just removed the "details" tag.

[alexgurr]

• Everything after the table of contents is inlined (tabbed in)

 

• There's no space/line break between the bullets and afterword

 

[ma-shamshiri]

Yes, you are right, sometimes this problem occurs due to improper indentation.
Is it fine now?

[alexgurr]

So I've just realised GitHub provides a table of contents out the box, no custom TOC required. This means we no longer have to keep the TOC updated or use HTML in the readme file. Let me know if there's anything else your PR provides, otherwise I'm closing this for now. (sorry we went back and forth for so long, I thought this GitHub TOC was from one of my extensions)