Yaml2Doc.Markdown 1.1.0

.NET 9.0 This package targets .NET 9.0. The package is compatible with this framework or higher. 
dotnet add package Yaml2Doc.Markdown --version 1.1.0
                    


                    

                
NuGet\Install-Package Yaml2Doc.Markdown -Version 1.1.0
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package. 
<PackageReference Include="Yaml2Doc.Markdown" Version="1.1.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="Yaml2Doc.Markdown" Version="1.1.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="Yaml2Doc.Markdown" />
                    


                            Project file
For projects that support Central Package Management (CPM), copy this XML node into the solution Directory.Packages.props file to version the package. 
paket add Yaml2Doc.Markdown --version 1.1.0
                    


                    

                
#r "nuget: Yaml2Doc.Markdown, 1.1.0"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package. 
#:package Yaml2Doc.Markdown@1.1.0
#:package directive can be used in C# file-based apps starting in .NET 10 preview 4. Copy this into a .cs file before any lines of code to reference the package. 
#addin nuget:?package=Yaml2Doc.Markdown&version=1.1.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=Yaml2Doc.Markdown&version=1.1.0
                    


                            Install as a Cake Tool

Yaml2Doc.Markdown

Yaml2Doc.Markdown provides a baseline Markdown renderer for the Yaml2Doc core model (PipelineDocument).

For v1.x, the renderer is intentionally small and predictable:

  • Renders a top-level heading from the document Name, if present.
  • Falls back to # YAML Document if no name is provided.
  • Emits a ## Root Keys section listing the top-level keys in the YAML document.

Starting with v1.1.0, the renderer can also surface dialect-aware sections when the PipelineDocument includes richer, dialect-specific metadata (e.g., triggers, jobs, steps). For a plain "standard YAML" document, the output remains identical to v1.0.0.

Use this package if you already have a PipelineDocument and just want a predictable Markdown representation, with optional dialect-aware extras when available.

Installation

dotnet add package Yaml2Doc.Markdown

Basic usage

Given a PipelineDocument (usually produced by Yaml2Doc.Core):

using Yaml2Doc.Core.Models;
using Yaml2Doc.Markdown;

// Suppose you obtained this from Yaml2Doc.Core
PipelineDocument document = GetPipelineDocumentSomehow();

// Create the renderer
IMarkdownRenderer renderer = new BasicMarkdownRenderer();

// Render to Markdown
string markdown = renderer.Render(document);

// Write or use the Markdown
Console.WriteLine(markdown);

Typical output shape for standard YAML:

# My Pipeline

## Root Keys

- name
- trigger
- jobs

For documents produced by dialects (e.g., GitHub Actions / Azure Pipelines), the renderer may additionally emit sections such as:

## Trigger
...

## Jobs
...

## Steps
...

These sections are additive: they sit alongside the existing heading and Root Keys section.

You can implement your own IMarkdownRenderer if you need a different layout or more opinionated dialect-specific Markdown.

API documentation

For full type and member details, see:

Product Compatible and additional computed target framework versions.
.NET net9.0 is compatible.  net9.0-android was computed.  net9.0-browser was computed.  net9.0-ios was computed.  net9.0-maccatalyst was computed.  net9.0-macos was computed.  net9.0-tvos was computed.  net9.0-windows was computed.  net10.0 was computed.  net10.0-android was computed.  net10.0-browser was computed.  net10.0-ios was computed.  net10.0-maccatalyst was computed.  net10.0-macos was computed.  net10.0-tvos was computed.  net10.0-windows was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages (1)

Showing the top 1 NuGet packages that depend on Yaml2Doc.Markdown:

Package Downloads
Yaml2Doc.Cli

Command-line tool that converts YAML pipeline definitions into Markdown documentation.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
1.1.0 193 12/4/2025
1.1.0-preview.26-ga1ebf43 168 12/4/2025
1.1.0-preview.25-gc4d1d21 168 12/4/2025
1.0.0 183 12/3/2025
1.0.0-preview.24-gd822a58 167 12/3/2025
1.0.0-preview.23-g2fad194 169 12/3/2025
1.0.0-preview.22-gd7f78e2 171 12/3/2025
1.0.0-preview.21-g71d2f29 173 12/3/2025
1.0.0-preview.20-ga2d3c5e 167 12/3/2025