XArch.StructuredMarkdown 0.1.7

Prefix Reserved
.NET Standard 2.1 This package targets .NET Standard 2.1. The package is compatible with this framework or higher. 
dotnet add package XArch.StructuredMarkdown --version 0.1.7
                    


                    

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


                            Directory.Packages.props
                        

                    

                
<PackageReference Include="XArch.StructuredMarkdown" />
                    


                            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 XArch.StructuredMarkdown --version 0.1.7
                    


                    

                
#r "nuget: XArch.StructuredMarkdown, 0.1.7"
#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 XArch.StructuredMarkdown@0.1.7
#: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=XArch.StructuredMarkdown&version=0.1.7
                    


                            Install as a Cake Addin
                        

                    

                
#tool nuget:?package=XArch.StructuredMarkdown&version=0.1.7
                    


                            Install as a Cake Tool

XArch.StructuredMarkdown

A .NET library for working with Simple Structured Markdown, enabling structured document management with metadata and visibility control.

Overview

XArch.StructuredMarkdown provides tools to parse and serialize documents that follow the Structured Markdown Format. This format enables:

  • Block-level section tags for grouping content with arbitrary metadata.
  • Inline metadata comments for fine-grained control over visibility and properties.
  • Tag comments for data tagging within session logs or summaries.

Features

1. Parsing

  • Parse documents using a stack-based approach, tracking current metadata context (visibility, tags, etc.).
  • Supports both section tags and inline metadata comments.

2. Serialization

  • Generate structured markdown with proper formatting for sections, inline comments, and tag comments.
  • Preserve unknown metadata keys during round-trip editing.

Usage

Install the package via NuGet:

dotnet add package XArch.StructuredMarkdown

Example: Parsing a Document

using XArch.StructuredMarkdown;

var document = StructuredMarkdownParser.Parse("path/to/document.md");

Example: Serializing a Document

using XArch.StructuredMarkdown;

string markdown = StructuredMarkdownSerializer.ToMarkdown(document);
File.WriteAllText("output.md", markdown);

Format Specification

For full details on the format, see the Markdown Content Partitioning and Tagging Spec.

Contributing

Contributions are welcome! Please open an issue or submit a pull request.

License

Apache 2.0 License. See LICENSE for more information.

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 was computed.  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 was computed.  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. 
.NET Core netcoreapp3.0 was computed.  netcoreapp3.1 was computed. 
.NET Standard netstandard2.1 is compatible. 
MonoAndroid monoandroid was computed. 
MonoMac monomac was computed. 
MonoTouch monotouch was computed. 
Tizen 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
0.1.7 207 7/9/2025