Class MarkdownConventions

Namespace

LMKit.Document.Parsing

Assembly

LM-Kit.NET.dll

The notation conventions of the Markdown a parsed document renders to: how scripts are written, whether table cells keep their inline emphasis, where running heads and feet go, and how charts read. They change how the content is written, never what was read.

public sealed class MarkdownConventions

Inheritance

object

MarkdownConventions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Set them on the parser (MarkdownConventions) to make them the rendering of every document it returns, or pass them to one rendering (ToMarkdown(MarkdownConventions), ToMarkdown(MarkdownConventions), ToMarkdown(MarkdownConventions)).

The defaults (Standard) write scripts as HTML tags, keep emphasis in table cells, place running heads first and feet last, and read charts as data tables. LatexMath writes scripts as LaTeX and drops the emphasis tags of table cells, for consumers that read math as LaTeX.

Constructors

MarkdownConventions()

Creates conventions holding the defaults (Standard).

Properties

Charts

How each chart reads. DataTable by default.

LatexMath

LaTeX scripts (Latex) and table cells without emphasis tags, every other convention at its default.

PageSeparator

Text written on a line of its own between pages (for instance --- or <!-- page break -->), or null (the default) for a blank line only.

RunningText

Where running heads and feet go. HeadersFirstFootersLast by default.

Scripts

How superscripts and subscripts are written. HtmlTags by default.

Standard

The default conventions: HTML script tags, emphasis kept in table cells.

TableCellEmphasis

Whether table cells keep their HTML emphasis tags (b, strong, i, em, u). true by default; false drops the tags and keeps their text. Markdown emphasis marks are kept either way.

TaskListMarkers

Whether the check boxes the page prints are written as Markdown task markers, [ ] and [x]. true by default; false keeps the glyphs as printed.

Underline

Whether running text keeps the underline tags (<u>) of the words the page underlines. true by default; false drops the tags and keeps their text. Table cells follow TableCellEmphasis; code keeps its text as written.

UnderscoreEmphasis

Whether emphasis a reading writes between underscores (word, word) keeps them. true by default; false writes it between asterisks, the delimiter the rendering sets its own emphasis with. Blanks written as underscores, underscores inside words, tables, formulas and code are left as they are.

Methods

Clone()

A copy of these conventions.