Ultimate Markdown Pro

Documentation of the Ultimate Markdown Pro plugin for WordPress

Table of Contents

  1. Introduction
  2. Installation
  3. Post sidebar sections
  4. Dedicated menus
  5. REST API
  6. Additional information

Introduction

Ultimate Markdown Pro helps you work with the Markdown syntax by providing tools to import, export, and modify Markdown documents.

Installation

Please use the installation guide for installation and update instructions. The information available in this document applies to all our WordPress plugins.

Post sidebar sections

The plugin adds four new sections in the sidebar of your posts, pages, or custom post types.

To access these sections, open the post sidebar with the cog icons available in the top-right area of the screen. Then select the Post tab of the sidebar.

Import Markdown

Use the Import Markdown section to generate the post content from a Markdown file available on your computer.

  1. Open the Import Markdown section
  2. Click the Upload file and import button
  3. Select a Markdown file available on your computer

Load Markdown

With this section, you can replace the existing post content with content generated from a document stored in the plugin. See the Documents and Import menu for more information on creating a document.

  1. Open the Load Markdown section
  2. Select a document stored in the plugin with the Markdown document selector
  3. Click the Submit document button to complete the process

Submit Markdown

The Submit Markdown section allows you generate the post content from a provided text string.

  1. Open the Submit Markdown section
  2. Enter text with the Markdown markup in the Markdown text textarea
  3. Click the Submit text button to complete the process

Export Markdown

The Export Markdown section allows you to generate a Markdown file from the content of the currently edited post.

  1. Open the Export Markdown section
  2. Click the Export button

The generated Markdown file will be available in the download location configured in your browser.

Dedicated menus

Documents

From the Documents menu you can create, duplicate, download, edit, or delete Markdown documents.

Create a document

Use this procedure to create a document:

  1. Enter the Title of the document
  2. Select the Category of the document or leave “None”
  3. Enter the Content of the document
  4. Click the Add Document button

Download a document

To download a document, click the Download icon (the first icon of the group) available in the last column of the table used to list the existing documents.

Categories

The Categories menu allows you to create categories of documents. You can optionally use this feature to better organize large archives of documents.

Create a category

  1. Enter the Name of the category
  2. Select the Description of the category
  3. Click the Add Category button

Import

Use this menu to generate documents from Markdown files available on your computer.

  1. Visit the Import menu
  2. Click the Choose Files button to select one or more files available on your computer
  3. Click the Upload files and import button to execute the operation
  4. At the end of the process, the plugin will provide you a list of the generated documents in a dismissible notice

Import (Classic)

This menu allows you to generate posts in draft status from Markdown files available on your computer.

  1. Visit the Import menu
  2. Click the Choose Files button to select one or more files available on your computer
  3. Click the Upload files and import button to execute the operation
  4. At the end of the process, the plugin will provide you a list of the generated documents in a dismissible notice

Configure the post type

You can define the post type of the generated posts with the Advanced -> Post Type option available in the Options menu.

Important note

We recommend using this menu only if the Classic Editor plugin is active in the targeted post type. Using this menu with the Block Editor will generate a single Classic Block instead of separate blocks for all the post elements.

The correct import workflow to use with the block editor active is as follows:

  1. Create documents from existing Markdown files with the Import menu
  2. Generate the post content from a selected document with the Load Markdown section in the post sidebar

Export

The Export menu allows you to mass export plugin documents or WordPress posts as compressed archives of Markdown files.

Export documents

To export the documents stored in the plugin, proceed as follows:

  1. Set the Source selector to Documents
  2. Click the Export Data button

Export posts

Use the procedure below to export posts, pages, or custom post types:

  1. Set the Source selector to Posts
  2. Open the Advanced section
  3. Select the post types used as a source with the Post Types option
  4. Select the categories of posts used as a source with the Categories option. Leave this option empty to use all the categories as a source.
  5. Select the tags used as a source with the Tags option. Leave this option empty to use all the tags as a source

REST API

This plugin adds the following REST API endpoints.

List documents

Use this endpoint to read the Markdown document stored in the plugin.

Base route

/wp-json/ultimate-markdown-pro/v1/documents

Method

GET

URL Parameters

NameValueRequired
document_idThe ID of the document that you want to retrieve. Leave this field empty to retrieve all the documents.No

Import documents

With this endpoint, you can add Markdown documents in the plugin database or create posts in draft status.

Base route

/wp-json/ultimate-markdown-pro/v1/import

Method

POST

URL Parameters

NameValueRequired
titleThe title of the submitted document.Yes
contentThe content of the submitted document. The Markdown syntax is supported.Yes

Additional information

Uploads

The maximum number of files you can upload in a single upload operation is limited by the max_file_uploads directive defined in the php.ini file.

This directive’s value determines the maximum number of files processed in the Import and Import (Classic) menus.

Parsers

The plugin uses multiple libraries to convert Markdown to HTML and vice-versa. This table lists the plugin contexts and the related parsers.

ContextUseLanguageParser
Markdown editor available in the Documents menuMarkdown to HTMLJavaScriptMarked
Export functionality available in the Documents menuHTML to MarkdownPHPHTML To Markdown for PHP
In the upload process of the Import (Classic) menuMarkdown to HTMLPHPDefined in the plugin settings. The options are: Parsedown, Cebe Markdown.
In the Export menu, when “Posts” is selected as the source.HTML to MarkdownPHPHTML To Markdown for PHP
Import Markdown section in post editor sidebarMarkdown to HTMLJavaScriptMarked
Submit Markdown section in the post editor sidebarMarkdown to HTMLJavaScriptMarked
Export Markdown section in the post editor sidebarHTML to MarkdownPHPHTML To Markdown for PHP

Supported Markdown file extensions

The forms available in the Import and Import (Classic) menus support Markdown files with the following extensions:

  • .md
  • .markdown
  • .mdown
  • .mkdn
  • .mkd
  • .mdwn
  • .mdtxt
  • .mdtex
  • .text
  • .txt

Credits

This product makes use of the following resources: