Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added Table of Contents to README #97

Closed
wants to merge 1 commit into from

Conversation

koomai
Copy link

@koomai koomai commented Sep 6, 2018

This PR adds a Table of Contents section to the README file.

I refer to the README quite often and find the links quite handy. It's very easy to generate. Here's how I do it:

  1. Install the markdown-toc npm package globally:
npm i -g markdown-toc
  1. Add the below to your README (where you want your Table of Contents to appear):
## Table of Contents
<!-- toc -->
<!-- tocstop -->
  1. Run the script in your application's directory:
markdown-toc README.md -i
  1. Check the README file and commit your changes.
  2. Profit.

Thanks.

@freekmurze
Copy link
Member

Thank you for this, but we're not going to merge it. If the readme becomes too big we'll move the docs to our dedicated documentation site.

@freekmurze freekmurze closed this Sep 14, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants