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

Markdown based documentation for packages #9

Open
anangaur opened this issue Sep 27, 2017 · 0 comments
Open

Markdown based documentation for packages #9

anangaur opened this issue Sep 27, 2017 · 0 comments

Comments

@anangaur
Copy link
Member

anangaur commented Sep 27, 2017

Announcing support for rich markdown based documentation for packages

This feature has following parts:
1. Ability to associate a markdown documentation to packages (and existing packages)
2. Understand markdown and render it properly on NuGet.org package details page

3. Ability to associate markdown documentation content while packing the package, from clients
4. Ability on VS client to show this markdown content.

1 and 2 have been implemented as part of 2017 Interns project and released now. Please provide your feedback on the feature - both implemented and pending parts.

Spec wiki Discussion issue
https://github.com/NuGet/Home/wiki/Package-README.md-support NuGet/NuGetGallery#2280

In order to put markdown documentation, you can edit an existing package and add the required documentation:
image

This will appear as below:
image

@NuGet NuGet locked and limited conversation to collaborators Sep 27, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant