Class MarkdownWriter

Namespace

DocWright.Formats.Markdown

Assembly

DocWright.Formats.Markdown.dll

Writes the DocWright document model as Markdown.

public sealed class MarkdownWriter : IDocumentWriter

Inheritance

object

MarkdownWriter

Implements

IDocumentWriter

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Remarks

This direction is lossy by nature and the losses are enumerated in COMPAT.md rather than discovered. Markdown has six block constructs and four inline ones; a Word document has no such bound. Everything outside the intersection — colour, font, size, alignment, page setup, headers and footers, footnotes, fields, revisions, content controls, merged cells — is reported through IConversionDiagnostics and dropped.

Output is UTF-8 without a byte-order mark and is deterministic: byte-identical across runs and across the four target frameworks for the same input. There are no timestamps and no generated identifiers.

Constructors

MarkdownWriter()

Initializes a writer with default options.

MarkdownWriter(MarkdownWriteOptions)

Initializes a writer with format-specific options.

Properties

Format

Gets the format this writer produces.

Methods

Write(IDocWrightDocument, Stream, DocumentWriteOptions, IConversionDiagnostics)

Writes the document to the stream.