WOLFRAM

Wolfram Language & System Documentation Center

Markdown (.md)

Background

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

Import & Export

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:
  • "FormattedText"a sequence of formatted text for the whole document
    "Hyperlinks"a list of Hyperlink objects
    "Images"a list of Image objects
    "Notebook"a Notebook expression
    "NotebookObject"a NotebookObject expression
    "Plaintext"a string giving the textual content of the whole document
    "Tables"a list of Tabular objects
  • Metadata elements:
  • "Title"document title
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
    GeneratedAssetFormatAutomaticthe file format of asset files
    GeneratedAssetLocationAutomaticthe location of asset files
    "WolframLanguageTag""wl"tag used for Wolfram Language code blocks
  • GeneratedAssetFormat can be set to the following values:
  • Automaticautomatic setting
    <|"Image"fmt1,"AniamtedImage"fmt2|>
  • use different formats for static and animated images
    • "fmt"use format "fmt" for static images
  • The following image formats are supported as the value of GeneratedAssetFormat option: "AVIF", "BMP", "GIF", "JPEG", "JPEG2000", "PNG", "TIFF", "WebP".
  • GeneratedAssetLocation can be set to the following values:
  • Automaticautomatic setting
    "CloudObject"
  • storing asset files in cloud objects
    • "CloudObjectPublic"storing asset files in cloud objects with permission set to public
    "LocalObject"
  • storing asset files in local objects
    • "dir/"storing asset files under the directory dir
    Nonestoring asset files as data URLs
  • In GeneratedAssetLocation"dir/", if the directory "dir" already exists then the trailing path name separator is optional.
  • "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  (10)

    Import  (2)

    Import a Markdown file as formatted text:

    Import a Markdown file as a NotebookObject:

    Export  (8)

    Export a styled text:

    Export a Hyperlink expression:

    Export an Image object:

    Export a Video object:

    Export a Tabular object:

    Import it back:

    Export a QuantityArray:

    Import it back as a Tabular object:

    Export a Notebook expression including item cells:

    Import a notebook file as a NotebookObject:

    Export to Markdown while the notebook is open:

    Import Elements  (9)

    Available Elements  (1)

    List of available elements:

    "FormattedText"  (1)

    Import the file as formatted text:

    "Hyperlinks"  (1)

    Import hyperlinks:

    "Images"  (1)

    Import images:

    "Notebook"  (1)

    Import the file as a Wolfram Notebook expression:

    "NotebookObject"  (1)

    Import the file as a Wolfram Notebook:

    "Plaintext"  (1)

    Import the file as plain text:

    "Tables"  (1)

    Import images:

    "Title"  (1)

    Import document title

    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  (10)

    "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:

    GeneratedAssetFormat  (2)

    By default, static images are exported as "PNG":

    Specify different format for static images:

    By default, animated images, Video and Manipulate objects are exported as "WebP":

    Specify different format for animated images:

    GeneratedAssetLocation  (5)

    Assets are automatically generated in the "img" folder in the same directory as the .md file:

    Store each asset as a LocalObject:

    Store each asset as a CloudObject with permission set to private:

    Store each asset as a CloudObject with permission set to public:

    Store each asset as a data URL:

    "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:

    "WolframLanguageTag"  (1)

    By default, "wl" is used as the Wolfram Language tag:

    Use the previously supported tag on most Markdown viewers: