question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Support formatting in description

See original GitHub issue

It would be nice to be able to add some basic formatting (perhaps using markdown) in the free-text fields of the nuspec file (summary, description and releaseNotes). Currently it’s hard to display the release notes properly.

See also this issue on CodePlex: https://nuget.codeplex.com/workitem/937

Issue Analytics

  • State:closed
  • Created 9 years ago
  • Reactions:27
  • Comments:43 (23 by maintainers)

github_iconTop GitHub Comments

4reactions
anangaurcommented, Sep 27, 2017

@ederbond We need to support older clients that do not understand markdown and we cannot go back in time to fix this for those clients. An alternative solution that we think works is to support “Documentation” for packages that can take markdown text. The solution 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.

While we are done with 1 and 2 as part of 2017 Interns project, we are yet to get started on 3 and 4. We did not want to wait for all 4 parts to complete before rolling out the feature. We have released the work we did so far for people who want to try it out (the current experience may not be an ideal one) and provide us feedback to improve the experience further.

We would love to hear further comments and feedback on the feature and accordingly we will proceed for 3 and 4.

3reactions
skofman1commented, Aug 22, 2018

Update on this topic: We are starting work on allowing to upload markdown documentation as part of the package: https://github.com/NuGet/Home/wiki/Packaging-Documentation-within-the-nupkg

The discussion issue for this feature is here: https://github.com/NuGet/Home/issues/6873 Closing this one as duplicate.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Pro Tip: Formatting Description Fields and Using HTML
There are a couple different methods for formatting your description text, whether the description is part of a schedule session, ...
Read more >
Text Formatting Notation Help - Create and track feature ...
Embeds an object in a page, taking in a comma-separated of properties. Default supported formats: Flash (. swf)
Read more >
Format text in Productboard descriptions
Formatting toolbar · Templates · Big headlines (h1) · Smaller headlines (h2) · Bold · Italics · Underline · Strikethrough · Inline code ......
Read more >
Text formatting in cards - Teams
Cards support formatting in the text property only, not in the title or subtitle properties. Formatting can be specified using a subset of...
Read more >
Formatting Descriptions on Ticket Forms
Hello! I would like the ability to either. Add formatting to the "Description shown to end users" part on a ticket form; Add...
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found