Skip to content

Support for NuGet readme #497

@distantcam

Description

@distantcam

I want to use MarkdownSnippets to generate a readme for GitHub and NuGet.

Currently I'm generating 1 file that is compatible with both. This means omitting the links as NuGet does not support html tags in the readme.

First issue. I would like a way to enforce "strict" markdown without any html output. The links could be rendered in markdown format instead of anchor tags, which would make them compatible with NuGet.

Second issue. It would be nice if I could generate 2 different readmes from the same source, but with different configs. I figure the easiest way to do this would be using the msbuild task, but there's currently an issue with nullable task parameters in msbuild dotnet/msbuild#4729

So, I'm wondering how to proceed. I'm happy to work on a PR.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions