[WIP] Update read me with TOC & other changes #1061
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
|
| @@ -17,7 +50,7 @@ or if you want to use the `marked` CLI tool (not necessary when using npm run-sc | |||
| npm install -g marked | |||
| ``` | |||
|
|
|||
| ## Usage | |||
| <h2 id="usage">Usage</h2> | |||
There was a problem hiding this comment.
I think github auto generates IDs on headings? It should be safe to reference #usage inside the document
There was a problem hiding this comment.
Could be fair. Was mentioned in the review on #1081 as well. I've always run into issues there; so, normally end up doing it by hand. Also, could make it more difficult to use in a non-GFM setting; at least here we know the TOC will always work.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Working on preparing to add @Feder1co5oave and @UziTech to the list of folks who can publish to NPM as well as possibly breaking up the README into separate files to help users out a bit as well.