Wordpress Markdown Support

Markdown is a lightweight markup language for adding formatting elements to plain text. PyCharm recognizes Markdown files, provides a dedicated editor with highlighting, completion, and formatting, and shows the rendered HTML in a live preview pane.

Wordpress Markdown Plugin

This WordPress Plugin lets you easily publish, collaborate on and version control your Markdown, Jupyter notebook documents directly from your favorite remote Git platform, even if it's self-hosted. The advantages are: Write documents in your favorite editor and just push to your remote repository to update your blog instantly. I've installed and set up XAMPP (v. 5.6.30-1) and Wordpress (v. 4.8) for some tests and I want to write posts in markdown. I found this official support document, stating that markdown support can simply be enabled in the settings, but this option is not available for me (see screenshot below). Then I tried to install the JP Markdown plugin, which kind of works, but only partially. Full-featured, open-source Markdown editor based on PageDown, the Markdown library used by Stack Overflow and the other Stack Exchange sites. With Markdown, you get a live preview of your formatted text inside your Microsoft Teams compose box as you type.

Create a new Markdown file

By default, PyCharm recognizes any file with the .md or .markdown extension as a Markdown file.

Right-click a directory in the Project tool window Alt+1 and select New | File.
Alternatively, you can select the necessary directory, press Alt+Insert, and then select File.
Enter a name for your file with a recognized extension, for example: readme.md.

The Markdown editor provides several basic formatting actions in the toolbar:

: Bold
: Strikethrough
: Italic
: Code
: Decrease heading level
: Increase heading level
: Convert an inline link to a reference link

You can use the preview pane to see the rendered HTML.

There is also completion for links to files in the current project, for example, if you need to reference source code, images, or other Markdown files.

Code blocks

To insert a fenced code block, use triple backticks (```) before and after the code block. If you specify the language for the code block, by default, the Markdown editor injects the corresponding language. This enables syntax highlighting and other coding assistance features for the specified language: code completion, inspections, and intention actions.

Disable coding assistance in code blocks

If your code blocks are not meant to be syntactically correct, you may want to disable code injection and syntax errors in code blocks.

In the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown.
Configure the following options:
Disable automatic language injection in code fences Do not inject any coding assistance for code blocks.
Hide errors in code fences Do not check the syntax for errors.
Click OK to apply the changes.

Diagrams

The Markdown editor can render diagrams defined with Mermaid and PlantUML. This is disabled by default and requires the corresponding Markdown extensions.

Enable diagram support

In the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown.
Enable either Mermaid or PlantUML under Markdown Extensions.
After PyCharm downloads the relevant extensions, click OK to apply the changes.

HTML preview

By default, the Markdown editor shows a preview pane next to it for rendered HTML code based on the Markdown file. You can use or in the top right corner of the Markdown editor to show only the editor or the preview pane.

The scrollbars in the editor and in the preview pane are synchronized, meaning that the location in the preview pane corresponds to the location in the source. To disable this, click in the top right corner of the Markdown editor.

To split the editor and preview pane horizontally (top and bottom) instead of the default vertical split, in the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown, and then select Split horizontally under Editor and Preview Panel Layout.

Custom CSS

PyCharm provides default style sheets for rendering HTML in the preview pane. These style sheets were designed to be consistent with the default UI themes. You can configure specific CSS rules to make small presentation changes (for example, change the font size for headings or line spacing in lists) or you can provide an entirely new CSS to better match your expected output (for example, if you want to replicate the GitHub Markdown style).

In the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown.
Configure the settings under Custom CSS:
- Select Load from URI to specify the location of a custom CSS file.
- Select Add CSS rules rules to enter specific CSS rules that you want to override.

Reformat Markdown files

PyCharm can format Markdown files with proper line wrappings, blank lines, and indentation. For more information, see Reformat and rearrange code.

From the main menu, select Code | Reformat Code or press Ctrl+Alt+L.

PyCharm formats the contents according to the code style settings for Markdown files.

Configure Markdown code style settings

In the Settings/Preferences dialog Ctrl+Alt+S, select Editor | Code Style | Markdown.

Markdown code style settings include the following:

Configure the options for breaking lines.

Hard wrap at	Specify at which column to put a line break. PyCharm shows a vertical line at the specified column and breaks lines between words, not within words.
Wrap on typing	Add line breaks as you type. Disable this option to add line breaks only when PyCharm performs formatting.
Visual guides	Show an additional vertical line at the specified column.

Configure the options for nesting text blocks and alignment within a block.

Use tab character	Use the tab character for indentation. Disable this option to use spaces for indentation.
Smart tabs	Nest blocks with tabs and align with spaces. Disable this option to use only tabs and replace spaces that fit the specified tab size with tabs.
Tab size	Specify the number of spaces to render in place of one tab character.
Indent	Specify the number of spaces used for each indentation level.
Continuation indent	Specify the number of spaces used for continuing the same text block.
Keep indents on empty lines	Retain tabs and spaces on empty lines. By default, this option is disabled and PyCharm removes tabs and spaces if there is nothing else on that line.

Set the maximum and minimum number of blank lines to keep for various text elements.

Around header	Before and after chapter headings.
Around block elements	Before and after code blocks.
Between paragraphs	Between two adjacent paragraphs.

Specify which elements should have exactly one space.

Between words	Remove extra spaces between words.
After header symbol	Remove extra spaces or add a missing space between the header symbol and the header title.
After list marker	Remove extra spaces or add a missing space between the list item marker and the list item text.
After blockquote marker	Remove extra spaces or add a missing space between the block quote marker and the text of the block quote.