Webstorm Markdown

Posted on  by admin

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

JetBrains WebStorm webstorm by jetbrains jetbrains webstorm price webstorm community edition webstorm JetBrains. Aug 23, 2015 I started using markdown because I was looking for a way to increase my project’s documentation quality. There are many tools to edit, view and export markdown files, but as I am using IntelliJ for development anyway, I wanted to check if there’s a plugin, so I do not need to install an additional standalone program to do so.

Create a new Markdown file

  1. Explore the new features in WebStorm 2020.3: More polished look and feel, Tailwind CSS support, improvements for JavaScript and TypeScript, and Git staging support.
  2. Markdown的相关语法,自己去官网看,或网上搜资料很多的。这里讲一下webstorm安装使用markdown插件。 步骤 打开webstorm,File-Settin.

By default, WebStorm 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.

Webstorm markdown download

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.

  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.

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 WebStorm 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

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

  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

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

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

Webstorm Markdown Code

WebStorm 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 Configuring colors and fonts.

Navigate in a large Markdown file

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

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:

There must be a blank line before the link label.

  • 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: 08 March 2021
Early Access Program

WebStorm 2020.3 EAP build #2 is now available! We encourage you to download it, try the latest enhancements, and share your feedback with us.

Markdown

If you’re unfamiliar with our Early Access Program, check out this blog post where we explain what the EAP is about and why to take part in it (spoiler: you could get a free WebStorm license). If you want to catch up on all the new features, check out our previous EAP blog posts.

The Toolbox App is the easiest way to get the EAP builds and keep both your stable and EAP versions up to date. Or you can manually download the EAP builds from our website.

Important! WebStorm EAP builds are not fully tested and might be unstable.

Here are some of the highlights of WebStorm 2020.3 EAP #2 (build 203.4203.27). For the full list of issues fixed in this update, see the release notes.

Markdown editing and preview enhancements

With WebStorm 2020.3, we’ve significantly improved the experience of working with .md files.

You can now reformat the content of your .md files to be in line with popular Markdown style guides. To do so, press ⌘⌥L / Ctrl+Alt+L. You can modify the related code style settings in Preferences/Settings Editor Code Style Markdown.

Whenever you switch to a custom UI theme, WebStorm will automatically change the color of the preview pane.

We’ve also added support for Mermaid.js, a popular diagramming and charting tool. You can turn it on in Preferences/Settings Languages & Frameworks Markdown.

Finally, if you click on the Auto-Scroll Preview button in the top right corner of the preview pane, that pane will be synced to scroll along with the editor.

Improved spelling and grammar checking

Starting with v2020.1, WebStorm comes bundled with our spelling and grammar checker. We strive to make this tool as helpful as possible, so we’ve been implementing various improvements for it.

You can now address grammar and spelling issues faster – hover over problems and you’ll get a popup with an explanation and a suggested fix shown right in it. To see the full list of actions available in the current context, click More actions or press Alt+Enter.

Webstorm Markdown Code

We’ve also updated to a new version of the grammar checking engine with support for more languages and better-quality grammar checks.

That’s it in terms of the biggest highlights. This build also comes with some smaller, but still important changes such as:

  • When reformatting code, the IDE will chop destructured objects if they are long. You can change this behavior by playing with the settings under the Object section in Preferences/Settings Editor JavaScript > Wrapping and Braces.
  • On Windows, you can now merge the main menu with the window title. To do that, tick the Merge main menu with window title option in Settings Appearance & Behavior Appearance.
  • Pinned tabs are now always displayed at the beginning of the tab bar, making it easier to find them.

The WebStorm team