Home

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, syntax highlighting, basic editing functionality with link completions with split editor preview is available in the basic open source edition. Intended for mostly previewing and editing of markdown documents without full document format.

Advanced features used for creating and maintaining markdown documents such as refactoring, find usages, validation and document formatting are available in the Enhanced licensed version. 15-day free trial licenses are available from Markdown Navigator website.

The original 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 extends the joy principle to the inevitable documentation tasks of the project.

The new flexmark-java markdown parser implementation allows user selectable target Markdown processors for making the preview, formatting and annotations reflect the idiosyncrasies of the target markdown processor.

Enhanced Features

Table of Contents

• Installation
• Adding Table of Contents
• Adding GitHub Wiki to IntelliJ Project
• Changing Boot JDK
• Customizing HTML Preview
• Configuration and Customization
  • Document Format Settings
  • Plugin Settings
    • Editor Settings
    • Preview Settings
    • Parser Settings
    • Stylesheet Settings
    • Html Generation Settings
      • Fenced Code Rendering Settings
    • Html Export Settings
    • Modifying Link Processing
    • Custom Rendering Profiles
    • Experimental and Internal Tweaks
    • Diagnostic Reports
• Markdown Extensions
  • Admonition Extension
  • Attributes Extension
  • Emoji Extension
  • Enumerated References Extension
  • Footnotes Extension
  • Macros Extension
  • Table of Contents Extension
  • Tables Extension
• Frequently Asked Questions
• Screenshots

Troubleshooting Common Problems

• Frequent Source of Problems: More than one Markdown plugin is enabled
• Markdown Documents Have Light Background Patches
• JavaFX WebView HTML Preview Not Working
• GitHub Links Do Not Work
• IDE Crashes or Hangs After New Version of the Plugin Is Installed
• Links do not work and Images do not show on GitHub