Markdown Generator is a library for generating Markdown documents programatically. It implements the CommonMark specification as well as the table extension specified by GitHub Flavored Markdown.
MarkdownGenerator is distributed as NuGet package.
MarkdownGenerator is a .NET Standard library. Building it from source requires the .NET 6 SDK (version 6.0.101 as specified in global.json) and uses Cake for the build.
To execute the default task, run
.\build.ps1This will build the project, run all tests and pack the NuGet package.
If you run into any issues or if you are missing a feature, feel free to open an issue.
I'm also using issues as a backlog of things that come into my mind or things I plan to implement, so don't be surprised if many issues were created by me without anyone else being involved in the discussion.
Markdown Generator was made possible through a number of libraries (aside from .NET Core and .NET Standard):
The implementation of ASCII-art tree used to visualize the structure of a document
is basd on AsciiTreeDiagram
by Andrew Lock, licensed under the MIT license.
See Creating an ASCII-art tree in C# for details.
Addititional dependencies (used for testing), in no specific order:
- Markdig
- Roslyn
- xUnit
- PublicApiGenerator
- ApprovalTests
- Moq
- Xunit.Combinatorial
- Cake
- Cake.BuildSystems.Module
The version of the library is automatically derived from git and the information
in version.json using Nerdbank.GitVersioning:
- The master branch always contains the latest version. Packages produced from
master are always marked as pre-release versions (using the
-presuffix). - Stable versions are built from release branches. Build from release branches
will have no
-presuffix - Builds from any other branch will have both the
-preprerelease tag and the git commit hash included in the version string
To create a new release branch use the nbgv tool
(at least version 3.0.24):
dotnet tool install --global nbgv
nbgv prepare-release