Using Markdown Documents Leave feedback

Note

This feature is supported by version 19.8 or greater.

Note

The code uses some of the objects defined in The Business Layer.

Markdown is a lightweight markup language intended for one purpose, to be used to format text on the web with plain text formatting syntax. Let it be clear that Markdown is not a replacement for HTML because its syntax is very small, containing a very small subset of HTML tags. The reason behind the Markdown is to make it easy to read, write and edit prose. In other words we can say that HTML is a publishing format while the Markdown is a writing format.

The text files created with Markdown language dialects is saved with .MD or .MARKDOWN file extension. The MD files are saved in plain text format that uses Markdown language which also includes inline text symbols, defining how a text can be formatted such as indentations, table formatting, fonts, and headers.

Since version 19.8, the GroupDocs.Assembly provides abilities for saving of assembled Markdown documents to Word Processing formats and saving of assembled Word Processing documents and emails to Markdown. 

The API supports the following Markdown features:

• Headings
• Block quotes
• Horizontal rules
• Bold emphasis
• Italic emphasis

Note

This feature is supported by version 19.11 or greater.

Since version 19.11, the following Markdown features are supported when saving assembled Markdown documents to Word Processing formats and saving assembled Word Processing documents and emails to Markdown:

• Indented code blocks 
• Fenced code blocks
• Inline code spans
• Strikethrough text
• Unordered list (v 19.12 or later)

Following sections show that how we can load from and save to Markdown documents:

Suppose, we have an assembled Markdown (MD) document (ReadMe.md) as template having the content as shown below:

# <<[product]>>
-----
## Description
<<[description]>>
## Evaluation and Licensing
The library comes up with some limitations in the evaluation mode. 
In order to test full features of <<[product]>>, 
please request a **free 30-day temporary license**.

The following code snippet demonstrates the saving this MD document to a Word Processing file.

The resultant word document (ReadMe Out.docx) is available for download.

Note

The version 19.8 supports only assembled emails and Word Processing documents to save into Markdown format.

Suppose, we have a Word Processing template(ReadMe.docx) having the same content as above Markdown template.

The following code snippet demonstrates the saving this assembled Word Processing document to a Markdown file.

The resultant word document (ReadMe Out.md) is available for download.

The following code snippet shows the saving of an assembled Word Processing document or email to Markdown using explicit specifying: