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

add a menu for readme for easier readability #1234

Merged
merged 1 commit into from
Sep 18, 2016

Conversation

PeterDaveHello
Copy link
Collaborator

Add menu for the first two level titles for better readability

@@ -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