CLion 2021.1 Help

Markdown

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

Create a new Markdown file

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

  1. 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.

  2. 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: Bold

  • Strikethrough: Strikethrough

  • Italic: Italic

  • Code: Code

  • Decrease header level: Decrease heading level

  • Increase header level: Increase heading level

  • Introduce reference: Convert an inline link to a reference link

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

Markdown editor

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.

Insert a fenced code block in Markdown

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.

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown.

  2. Configure the following options:

    Disable automatic language injection in code fencesDo not inject any coding assistance for code blocks.
    Hide errors in code fencesDo not check the syntax for errors.
  3. 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.

Mermaid diagram in Markdown

Enable diagram support

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown.

  2. Enable either Mermaid or PlantUML under Markdown Extensions.

  3. After CLion 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 The Show Editor Only button or The Show Preview Only button 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 The Auto-Scroll Preview button 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.

Markdown editor and live preview pane split horizontally

Custom CSS

CLion 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).

Markdown preview with a custom CSS that resembles GitHub rendering style
  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Languages & Frameworks | Markdown.

  2. 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

CLion can format Markdown files with proper line wrappings, blank lines, and indentation. For more information, see Code formatting.

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

CLion 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 atSpecify at which column to put a line break. CLion shows a vertical line at the specified column and breaks lines between words, not within words.
Wrap on typingAdd line breaks as you type. Disable this option to add line breaks only when CLion performs formatting.
Visual guidesShow an additional vertical line at the specified column.

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

Use tab characterUse the tab character for indentation. Disable this option to use spaces for indentation.
Smart tabsNest 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 sizeSpecify the number of spaces to render in place of one tab character.
IndentSpecify the number of spaces used for each indentation level.
Continuation indentSpecify the number of spaces used for continuing the same text block.
Keep indents on empty linesRetain tabs and spaces on empty lines. By default, this option is disabled and CLion 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 headerBefore and after chapter headings.
Around block elementsBefore and after code blocks.
Between paragraphsBetween two adjacent paragraphs.

Specify which elements should have exactly one space.

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

Productivity tips

Customize highlighting for Markdown

CLion highlights various Markdown elements according to the color scheme settings.

  1. In the Settings/Preferences dialog Ctrl+Alt+S, select Editor | Color Scheme | Markdown.

  2. Select the color scheme, accept the highlighting settings inherited from defaults, or customize them as described in Colors and fonts.

  • Use the Structure tool window Alt+7 or the File Structure popup Ctrl+F12 to view and jump to the relevant headings.

Add comments to a Markdown file

Markdown does not have dedicated syntax for commenting out lines. However, it is possible to emulate a comment line using a link label without an address, like this:

[comment]: <> (Your comment text)

  • Put the caret at the line that you want to comment out and press Ctrl+/.

    This will add a link label with the commented out text in parentheses and a blank line before it if necessary. Press the same shortcut to uncomment.

Last modified: 26 April 2021