MarkdownSnippets 28.2.0

.NET 8.0 This package targets .NET 8.0. The package is compatible with this framework or higher. .NET Standard 2.0 This package targets .NET Standard 2.0. The package is compatible with this framework or higher. .NET Framework 4.8 This package targets .NET Framework 4.8. The package is compatible with this framework or higher. 
dotnet add package MarkdownSnippets --version 28.2.0
                    


                    

                
NuGet\Install-Package MarkdownSnippets -Version 28.2.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="MarkdownSnippets" Version="28.2.0" />
For projects that support PackageReference, copy this XML node into the project file to reference the package. 
<PackageVersion Include="MarkdownSnippets" Version="28.2.0" />
                    


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="MarkdownSnippets" />
                    


                            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 MarkdownSnippets --version 28.2.0
                    


                    

                
#r "nuget: MarkdownSnippets, 28.2.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 MarkdownSnippets@28.2.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=MarkdownSnippets&version=28.2.0
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=MarkdownSnippets&version=28.2.0
                    


                            Install as a Cake Tool

MarkdownSnippets

A dotnet tool or MsBuild Task that extract snippets from code files and merges them into markdown documents.

See https://github.com/SimonCropp/MarkdownSnippets for full documentation.

Behavior

  • Recursively scan the target directory for code files containing snippets.
  • Recursively scan the target directory for markdown (.md or mdx) files.
  • Merge the snippets into those markdown files.

Installation

Ensure dotnet CLI is installed.

Install MarkdownSnippets.Tool

dotnet tool install -g MarkdownSnippets.Tool

Usage

mdsnippets C:\Code\TargetDirectory

If no directory is passed the current directory will be used, but only if it exists with a git repository directory tree. If not an error is returned.

Defining Snippets

Any code wrapped in a convention based comment will be picked up. The comment needs to start with begin-snippet: which is followed by the key. The snippet is then terminated by end-snippet.

// begin-snippet: MySnippetName
My Snippet Code
// end-snippet

Named C# regions will also be picked up, with the name of the region used as the key.

#region MySnippetName
My Snippet Code
#endregion

Using Snippets in Markdown

The raw snippet key can be used in any markdown document by subsequent surrounding it with snippet::
Product Compatible and additional computed target framework versions.
.NET net5.0 was computed.  net5.0-windows was computed.  net6.0 was computed.  net6.0-android was computed.  net6.0-ios was computed.  net6.0-maccatalyst was computed.  net6.0-macos was computed.  net6.0-tvos was computed.  net6.0-windows was computed.  net7.0 was computed.  net7.0-android was computed.  net7.0-ios was computed.  net7.0-maccatalyst was computed.  net7.0-macos was computed.  net7.0-tvos was computed.  net7.0-windows was computed.  net8.0 is compatible.  net8.0-android was computed.  net8.0-browser was computed.  net8.0-ios was computed.  net8.0-maccatalyst was computed.  net8.0-macos was computed.  net8.0-tvos was computed.  net8.0-windows was computed.  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 is compatible.  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. 
.NET Core netcoreapp2.0 was computed.  netcoreapp2.1 was computed.  netcoreapp2.2 was computed.  netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.0 is compatible.  netstandard2.1 is compatible. 
.NET Framework net461 was computed.  net462 was computed.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 is compatible.  net481 was computed. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen tizen40 was computed.  tizen60 was computed. 
Xamarin.iOS xamarinios was computed. 
Xamarin.Mac xamarinmac was computed. 
Xamarin.TVOS xamarintvos was computed. 
Xamarin.WatchOS xamarinwatchos was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

NuGet packages

This package is not used by any NuGet packages.

GitHub repositories

This package is not used by any popular GitHub repositories.

Version Downloads Last Updated
28.2.0 43 4/15/2026
28.1.0 86 4/14/2026
28.0.2 304 3/30/2026
28.0.1 202 3/5/2026
28.0.0 670 2/7/2026
28.0.0-beta.25 63 1/25/2026
28.0.0-beta.24 57 1/24/2026
28.0.0-beta.23 60 1/24/2026
28.0.0-beta.22 50 1/23/2026
28.0.0-beta.21 61 1/23/2026
28.0.0-beta.20 59 1/23/2026
28.0.0-beta.19 58 1/22/2026
28.0.0-beta.18 58 1/22/2026
28.0.0-beta.17 64 1/22/2026
28.0.0-beta.16 51 1/21/2026
28.0.0-beta.15 52 1/21/2026
28.0.0-beta.13 66 1/19/2026
28.0.0-beta.11 59 1/14/2026
28.0.0-beta.10 232 12/18/2025
28.0.0-beta.9 231 12/18/2025
Loading failed