WOLFRAM

Wolfram Language & System Documentation Center

Markdown (.md)

Background & Context

    • Registered MIME types: text/markdown, text/x-markdown
    • A markup language allowing formatting text documents.
    • Plain text format.

Import & Export

  • Import["file.md"] imports a Markdown file as plaintext.
  • Import["file.md",elements] imports the specified elements.
  • The import format can be specified with Import["file","Markdown"] or Import["file",{"Markdown",elem,…}].
  • Export["file.md",expr] creates a Markdown file from expr.
  • Expressions representing table data are exported as Markdown tables.
  • Image and Graphics objects are converted to PNG images when exporting to Markdown.
  • See the following reference pages for full general information:
  • Import, Exportimport from or export to a file
    CloudImport, CloudExportimport from or export to a cloud object
    ImportString, ExportStringimport from or export to a string
    ImportByteArray, ExportByteArrayimport from or export to a byte array

Notebook Interface

  • Save As exports the active notebook as a Markdown file.

Import Elements

  • General Import elements:
  • "Elements" list of elements and options available in this file
    "Summary"summary of the file
    "Rules"list of rules for all available elements
  • Data representation elements:
  • "Plaintext"a string giving the textual content of the whole document
    "FormattedText"a sequence of formatted text for the whole document
    "Notebook"a Notebook expression
    "NotebookObject"a NotebookObject expression

Import Options

  • Import options include:
  • ByteOrderingAutomaticordering of bytes
    CharacterEncoding"UTF8ISOLatin1"raw character encoding used in the file
    "ImportImages"True
  • whether to import images
  • By default, Import attempts to interpret the data as "UTF8"-encoded text. If any sequence of bytes stored in the file cannot be represented in "UTF8", Import uses "ISOLatin1" instead.

Export Options

  • Export options include:
  • "ExpressionFormattingFunction"Automatic
  • how expressions stored in a Tabular object are converted to strings
    • "SnippetRowCount"Infinitynumber of rows taken from the beginning and the end of table data during conversion to strings
  • "ExpressionFormattingFunction" can be set to the following values:
  • Automaticdefault conversion to string
    formany form supported by Format such as InputForm
    farbitrary function that converts an expression to a string
  • "SnippetRowCount" can be set to the following values:
  • Infinityall rows are exported
    nonly the first n rows are exported
    {n}the first and the last n rows are exported
    {m,n}the first m and and the last n rows are exported

Examples

open all close all

Basic Examples  (3)

Import a Markdown file as plain text:

Import summary of a Markdown file:

Export a mathematical expression to Markdown:

Import the rasterized expression:

Scope  (4)

Import  (2)

Import a Markdown file as formatted text:

Import a Markdown file as a NotebookObject:

Export  (2)

Export a Tabular object:

Import it back:

Export a QuantityArray:

Import it back as a Tabular object:

Import Elements  (5)

Available Elements  (1)

List of available elements:

"Plaintext"  (1)

Import the file as plain text:

"FormattedText"  (1)

Import the file as formatted text:

"Notebook"  (1)

Import the file as a Wolfram Notebook expression:

"NotebookObject"  (1)

Import the file as a Wolfram Notebook:

Import Options  (3)

CharacterEncoding  (1)

The character encoding can be set to any value from $CharacterEncodings:

"ImportImages"  (2)

By default, images are imported:

With "ImportImages"False, images are not imported:

Export Options  (2)

"ExpressionFormattingFunction"  (1)

By default, Export uses different conversion to string depending on column types:

Use "ExpressionFormattingFunction"->InputForm to get string versions of expressions suitable for input to the Wolfram Language:

Use an arbitrary function that converts expressions to strings:

"SnippetRowCount"  (1)

By default, all rows of table data are exported:

Use the "SnippetRowCount" option to export the first 2 rows and the last 3 rows: