On this page:
PyCharm makes it possible to work with the Markdown files.
The Markdown files are marked with icon.
Before you start working with Markdown, make sure that Markdown Support plugin is installed and enabled. The plugin is not bundled with PyCharm.
Changes to the UI
With the Markdown Support enabled, The page Markdown appears in the Languages and Frameworks section of the Settings/Preferences dialog.
Note also, that Structure view shows the headings of the various levels:
Creating a Markdown file
To create a Markdown file, follow these steps
- Do one of the following:
- Choose on the main menu.
- Right-click the target directory where the new file should be created, and choose on the context menu.
- Press Alt+Insert
- Choose .
- In the New File dialog box, specify the new file name and extension
The new file
<name>.md, marked with icon, is created and opens for editing.
The editor of a
<name>.md file by default shows the following:
Click one of the links to get rid of the banner. It's recommended to choose the link Change preview browser to JavaFX.
The editor is divided into two panes: the editor itself and the preview. Each of the panes can be hidden.
|Toggle bold mode||Inserts two asterisks before and after the selected text to render bold font.|
|Toggle italic mode||Inserts underscores before and after the selected text to render italic font.|
|Toggle monospaced (code span) mode||Inserts single apostrophes before and after the selected text to render monospaced font.|
|Show editor only||Shows editor only with Markdown syntax.|
|Show editor and preview||Shows editor with Markdown syntax and the corresponding preview. The results of editing are immediately reflected in the preview pane.|
|Show preview only||Shows preview that renders the Markdown syntax. Editing is not possible, and the buttons , and are disabled.|
Last modified: 26 July 2017