Documentarian.MarkdownBuilder

Commands and helpers for interacting with a specialized string builder for Markdown.

  less than a minute  

The Documentarian.MarkdownBuilder module provides functions for writing Markdown through the MarkdownBuilder object, which provides a friendly wrapper around the System.Text.StringBuilder class.

You can use it to write Markdown programmatically in your scripts and functions. It supports chaining writing statements in the pipeline, like chaining methods on StringBuilder.

The MarkdownBuilder supports defining and overriding default values for how it writes new lines and code fences. It tracks code fences as you open and close them, automatically ensuring that your codeblocks remain valid even when you add a nested code block.

Concepts

Conceptual documentation for the module.

Tutorials

Narrative documentation for the module.

Reference

Reference documentation for the module’s code.

Changelog

All notable changes to the Documentarian.MarkdownBuilder module are documented in this file.

This changelog’s format is based on Keep a Changelog and this project adheres to Semantic Versioning.

For releases before 1.0.0, this project uses the following convention:

  • While the major version is 0, the code is considered unstable.
  • The minor version is incremented when a backwards-incompatible change is introduced.
  • The patch version is incremented when a backwards-compatible change or bug fix is introduced.

Last modified June 5, 2023: (MAINT) Scaffold MarkdownBuilder module (1a676e7)