Skip to content

Releases: ap0llo/markdown-generator

v3.0.106

25 Feb 23:14
Compare
Choose a tag to compare

New Features

Bug Fixes

Breaking Changes

Details

Add support for GitHub Flavored Markdown "Task list items"

Breaking Change: This change introduces a new base class for list items (MdListItemBase) and changes both MdBulletList and MdOrderedList to use the base type instead of 'MdListItem'. This is a binary breaking change and requires recompilation of code consuming the library.

Add support for GitHub Flavored Markdown's task list items.

Task lists can be created by adding instances of MdTaskListItem instead of instances of MdListItem to either MdBulletList or MdOrderedLists.
Note that task lists might not be supported by all Markdown implementations.

Fix serialization of blank lines in code blocks

Blank lines in the content of MdCodeBlock block were being omitted when saving Markdown.

v2.5.34

03 May 18:18
Compare
Choose a tag to compare

New Features

Bug Fixes

Details

Add option to include anchor tags in the output

Add MdSerializationOptions.HeadingAnchorStyle setting. If set to MdHeadingAnchorStyle.Tag, anchor tags for all headings will be included in the output.
By default no anchor tags are emitted (keeping current behavior)

Allow MdHeading.Anchor to be set

Make MdHeading.Anchor property settable. By default, property is initialized with auto-generated value (thus keeping previous behavior). In combination with the option to include anchor tags in the output, this allows customizing the names of anchors for linking within a page.

If MdHeading.Anchor is set to a null or whitespace value, no anchor tag is emittted, even if MdHeadingAnchorStyle is set to 'Tag'

Add public helper methods for generating Heading ids

Add HtmlUtilities.ToUrlSlug() method that exposes the logic to that is used to determine auto-generated ids/anchor for headings

Add methods to copy MdSerializationOptions instances

Add Clone() method to MdSerializationOptions that creates a copy of an otpions instance.
Cloning default instances (which are read-only) removes the read-only flag and returns a instance which's properties can be modified.

In addition to Clone() add the With() method to that allows specifiying a update action (as Action<MdSerializationOptions>) to apply to the copy.

Add MdHeadingAnchorStyle.Auto option

Add option MdHeadingAnchorStyle.Auto that allows to inlcude anchor tags in the output only if an anchor different from the auto-generated anchor was set.

Do not escape '/' when using the 'MkDocs' preset

v2.4.30

30 Dec 21:49
Compare
Choose a tag to compare

Automatic release by Azure DevOps. Package available on NuGet.org

Changes:

  • c6c5f28 feat: Add nullable annotations [ #15 ]
  • 2b808c9 fix: Always use UTF-8 encoding when saving documents
  • 093d3e0 docs: Add (auto-generated) API reference
  • cedd143 docs: Cleanup docs and add links to API reference
  • a0abcf4 build: Switch to .NET Core 3.1 SDK

v2.3.12

07 Oct 18:28
Compare
Choose a tag to compare

Package available on NuGet.org

Changes:

  • b3dd771 fix: Always use UTF-8 encoding when saving documents

v2.3.11

03 Oct 15:58
Compare
Choose a tag to compare

Package available on NuGet.org

Changes:

  • 3d63def feat: Add "preset" for MkDocs
  • 784633c feat: Add option to increase the indentation in multi-level lists
  • 7d7f531 fix: Prevent modifications of the default serialization options instance
  • eafac27 feat: Allow customization of escaping
  • a7e909c fix: Add blank lines before and after tables

v2.2.16

29 Aug 19:58
Compare
Choose a tag to compare

Package available on NuGet.org

Changes:

  • c6b198e Keep the root output directory in DocumentSet.Save() [ #12 ]
  • 189059f Mark FactoryMethods as obsolete
  • befdce5 Add TextDocument class
  • b5c0812 feat: Add generic DocumentSet (replaces MdDocumentSet, which is now obsolete)
  • 7345051 Make tests runnable in VS 2019 Test Explorer

v2.1.81

24 Aug 19:34
Compare
Choose a tag to compare

Stable release of version 2.1

This release contains no changes compared to last 2.1 build.
For list a list of changes, see v2.1.80-rc

v2.1.80-rc

24 Jun 19:07
Compare
Choose a tag to compare
  • Resolve constructor ambiguities
  • Add "MdAdmonition" block type
  • Add IReadOnlyCollection implementation and Insert() to MdCompositeSpan
  • Add IReadOnlyList implementation and Insert() to MdTableRow
  • Add IReadOnlyCollection implementation to MdTable
  • Implement IReadOnlyCollection and add Insert() to MdContainerBlock and MdList
  • Add MdTable.Insert()
  • Add MdDocumentSet
  • Add convenience constructors to MdEmphasisSpan and MdStrongEmphasisSpan to allow passing in multiple spans.
  • Add SyntaxVisualizer public
  • Fix more construtor ambiguities in container blocks
  • Add DeepEquals() method to all block and span classes
  • Add MdHeading.Anchor property to make linking to sections of a document easier
  • Add MdEmptyBlock
  • Fix typos in comments and inline documentation
  • Add MdParagraph.Add() method

v2.0.78

05 Aug 18:11
Compare
Choose a tag to compare
  • Breaking change: Text content of blocks is now represented as spans. By default, string content will now be escaped when saving a document (see for Span Types details).
  • Add "serialization options" that allow customizing the output for markdown constructs for which the CommonMark spec defines multiple possible syntaxes.
  • Breaking change: Simplified namespace structure: All public types are now part of the root namespace Grynwald.MarkdownGenerator.
  • Documentation was updated to be more detailed and provide more examples.

This release is available on NuGet.org

v1.1.8

19 Jul 21:58
Compare
Choose a tag to compare

Automatic release by VSTS

Package on NuGet.org