Skip to content
Vladimir Schneider edited this page Nov 11, 2016 · 51 revisions

Markdown Navigator plugin provides Markdown language support for IntelliJ IDEA, RubyMine, PhpStorm, WebStorm, PyCharm, AppCode, Android Studio and DataGrip.

You can download it on the JetBrains plugin page.

Previewing and syntax highlighting functionality is available in the Basic open source edition. Advanced features used for creating and maintaining markdown documents such as split editor, refactoring, find usages, validation, auto formatting and HTML page customizations only in the Enhanced licensed version. 15-day free trial licenses are available from Markdown Navigator page on my website.

The aim of this plugin is to be able to generate a preview that it is as close as possible to how the page will look on GitHub but do it with more IntelliJ OpenAPI intelligence to make editing and maintaining markdown documents easier. Developing with pleasure is only half the job. Real projects need to be documented. This plugin wants to extend the pleasure principle to the inevitable documentation part of the project.

GitHub may recognize variants of Markdown syntax that this plugin will not and vice versa. This is due to the parser differences and the fact that GitHub has a few syntax modifications that conflict with original Markdown spec. This plugin uses pegdown library by sirthias with a few extensions added to make the rendering of GFM more faithful.

Enhanced Features

Table of Contents

Installation
Document Format Options
Adding a Table of Contents
Adding GitHub Wiki to IntelliJ Project
Customizing HTML Preview
HTML Export
Modifying Link Processing
Changing Boot JDK
Frequently Asked Questions
Settings Affected by Plugin Name Change

Troubleshooting Common Problems

Screen Shots

Screen Shot Source Preview Large

Screen Shot Jfx Webview

Screen Shot Preview Html

Screenshot Colors and Fonts

Screenshot Main Licensed

Screenshot Parser

Screenshot Stylesheet

Screenshot Html