Join GitHub today
GitHub is home to over 28 million developers working together to host and review code, manage projects, and build software together.Sign up
Clone this wiki locally
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 extends the joy principle to the inevitable documentation part of the project.
With the new Markdown parser implementation, flexmark-java, the plugin is evolving towards allowing user selectable target Markdown processor for making the preview, formatting and annotations reflect the idiosyncrasies to which the document will be subjected at its final destination.
Table of Contents
Document Format Settings
Adding Table of Contents
Adding GitHub Wiki to IntelliJ Project
Customizing HTML Preview
Custom Rendering Profiles
Html Export Settings
Modifying Link Processing
Changing Boot JDK
Frequently Asked Questions
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