Table of Contents for README using Github flavored Markdown
New here? Learn about Bountify and follow @bountify to get notified of new bounties! x

I'm trying to create a Table of Contents that links to the appropriate sections when clicked. This is for the README and it uses Github flavored Markdown.

What's the best way to create that? A PR just demonstrating how the markdown would look would be great!

Here's how it currently looks

https://github.com/akshatpradhan/information-security-policy/tree/policy_v1#table-of-contents

awarded to skram
Tags
git
markdown

Crowdsource coding tasks.

1 Solution

Winning solution
Very nice, do all the links need to end with an hyphen for this to work?
alixaxel 6 years ago
I'm actually curious about the hyphen thing as well. I merged your pull request into my branch but noticed something interesting. When I click on Roles & Responsibilities, it goes to the proper section, but if I click on Access Management Policy, it doesn't go anywhere https://github.com/akshatpradhan/information-security-policy/tree/policy_v1
akshatpradhan 6 years ago
The ending hyphen seems to be a mistake - I'll fix in a sec with a new PR
skram 6 years ago
Awesome! Thank you! Quick question, do you think my PCI security policy is Hacker News worthy?
akshatpradhan 6 years ago
Also, I need a LICENSE for it, what's a good license for it? Creative Commons? http://creativecommons.org/licenses/by/3.0/ That looks like it gives people ability to make Commercial Use of this.
akshatpradhan 6 years ago
Thanks for awarding me the winning solution. It does look HN worthy but I do not know which license you should go with. Best, Mark / @Skram
skram 6 years ago
@akshatpradhan: Yes it does. Then http://creativecommons.org/licenses/by-nc-sa/3.0/ would probably be a better choice for you, http://creativecommons.org/choose/ makes it dead easy to choose an appropriate license.
alixaxel 6 years ago
View Timeline