Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Comments

add a menu for readme for easier readability#1234

Merged
ljharb merged 1 commit intonvm-sh:masterfrom
PeterDaveHello:readme
Sep 18, 2016
Merged

add a menu for readme for easier readability#1234
ljharb merged 1 commit intonvm-sh:masterfrom
PeterDaveHello:readme

Conversation

@PeterDaveHello
Copy link
Collaborator

Add menu for the first two level titles for better readability

README.markdown Outdated
@@ -1,5 +1,28 @@
# Node Version Manager [![Build Status](https://travis-ci.org/creationix/nvm.svg?branch=master)][3]

## Readme menu
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Typically this is called "Table of Contents"

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Updated!

- [License](#license)
- [Running tests](#running-tests)
- [Bash completion](#bash-completion)
- [Usage](#usage-1)
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

can we instead make this an explicit permalink, like "bash-completion-usage"?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think so, un less you change the title there.

@ljharb ljharb merged commit 8b3cf6c into nvm-sh:master Sep 18, 2016
@PeterDaveHello PeterDaveHello deleted the readme branch September 18, 2016 08:34
@PeterDaveHello PeterDaveHello restored the readme branch September 18, 2016 08:34
@PeterDaveHello PeterDaveHello deleted the readme branch September 18, 2016 08:34
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants