ap0llo-markdown-generator - Grynwald.MarkdownGenerator 1.1.8

A utility library to programatically generate markdown files

PM> Install-Package Grynwald.MarkdownGenerator -Version 1.1.8 -Source https://www.myget.org/F/ap0llo-markdown-generator/api/v3/index.json

Copy to clipboard

> nuget.exe install Grynwald.MarkdownGenerator -Version 1.1.8 -Source https://www.myget.org/F/ap0llo-markdown-generator/api/v3/index.json

Copy to clipboard

> dotnet add package Grynwald.MarkdownGenerator --version 1.1.8 --source https://www.myget.org/F/ap0llo-markdown-generator/api/v3/index.json

Copy to clipboard 
<PackageReference Include="Grynwald.MarkdownGenerator" Version="1.1.8" />
Copy to clipboard 
source https://www.myget.org/F/ap0llo-markdown-generator/api/v3/index.json

nuget Grynwald.MarkdownGenerator  ~> 1.1.8
Copy to clipboard

> choco install Grynwald.MarkdownGenerator --version 1.1.8 --source https://www.myget.org/F/ap0llo-markdown-generator/api/v2

Copy to clipboard 
Import-Module PowerShellGet
Register-PSRepository -Name "ap0llo-markdown-generator" -SourceLocation "https://www.myget.org/F/ap0llo-markdown-generator/api/v2"
Install-Module -Name "Grynwald.MarkdownGenerator" -RequiredVersion "1.1.8" -Repository "ap0llo-markdown-generator"
Copy to clipboard

Markdown Generator

Overview

Build Status Conventional Commits Renovate

MyGet NuGet

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.

  • For an overview of the library's API, see API
  • For usage examples see Examples

Installation

MarkdownGenerator is distributed as NuGet package.

  • Prerelease builds are available on MyGet
  • Release versions are available on NuGet.org

Building from source

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.ps1

This will build the project, run all tests and pack the NuGet package.

Issues

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.

Acknowledgments

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:

Versioning and Branching

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 -pre suffix).
  • Stable versions are built from release branches. Build from release branches will have no -pre suffix
  • Builds from any other branch will have both the -pre prerelease 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
  • .NETStandard 2.0
  • .NETStandard 2.0: 2.0.0.0

Owners

ap0llo

Authors

Andreas Gruenwald

Project URL

https://github.com/ap0llo/markdown-generator

License

MIT

Info

1 total downloads
0 downloads for version 1.1.8
Download (16.37 KB)
Found on the current feed only

Package history

Version Size Last updated Downloads Mirrored?
3.1.3-pre 61.18 KB Sun, 26 Feb 2023 19:30:37 GMT 0
3.1.2-pre 61.18 KB Sun, 26 Feb 2023 19:31:29 GMT 0
3.1.1-pre 61.16 KB Sun, 26 Feb 2023 12:09:26 GMT 0
3.0.106 61.16 KB Sat, 25 Feb 2023 23:14:34 GMT 0
3.0.106-pre 61.18 KB Sun, 26 Feb 2023 12:07:52 GMT 0
3.0.105-pre 61.17 KB Sat, 25 Feb 2023 22:50:47 GMT 0
2.5.34 56.42 KB Sun, 03 May 2020 18:17:12 GMT 0
2.4.30 54.03 KB Mon, 30 Dec 2019 21:48:15 GMT 1
2.3.12 50.2 KB Mon, 07 Oct 2019 18:27:28 GMT 0
2.3.11 50.19 KB Thu, 03 Oct 2019 15:57:23 GMT 0
2.2.16 47.56 KB Thu, 29 Aug 2019 19:57:30 GMT 0
2.1.81 44.98 KB Sat, 24 Aug 2019 19:33:28 GMT 0
2.0.78 31.61 KB Sun, 05 Aug 2018 17:59:51 GMT 0
1.1.8 16.37 KB Thu, 19 Jul 2018 21:46:29 GMT 0
1.0.4 16.18 KB Thu, 31 May 2018 20:04:39 GMT 0