Markdown Navigator

The plugin for Markdown language support on IntelliJ IDEA, RubyMine, PhpStorm, WebStorm, PyCharm, AppCode, Android Studio, CLion and DataGrip.

No promotions are currently available.

Buy License via PayPal Get Trial License

A Markdown plugin with GFM and a matching preview style.

Document with pleasure!

Work with Markdown files like you do with other languages in the IDE, by getting full support for:

  • Paste images into documents for fast screen capture links
  • Drag & Drop files and images for fast link insertion
  • Formatting to cleanup documents with a key stroke
  • Navigation and Find Usages to find references without effort
  • Copy Markdown as JIRA, YouTrack or HTML formatted text
  • Convert HTML to Markdown by pasting it into a Markdown document.
  • Export to HTML or PDF to share with others
  • Refactoring of all referencing elements:
    • files ⟺ links
    • headings ⟺ ref anchors
    • footnotes ⟺ footnote refs
    • references ⟺ ref links/ref images
  • Completions to reduce typing:
    • link address ⇐ files
    • ref anchors ⇐ headings
    • footnote refs ⇐ footnotes
    • ref links/ref images ⇐ references
    • link text ⇐ ref anchor/link address
  • Error and Warning annotations to help catch mistakes early
  • Intention actions for fast results with less effort
  • Wrap on Typing to keep it nicely formatted as you edit
  • GitHub style rendering that you are used to, out of the box
  • Fast typing response for distraction free editing
  • Fully customizable to adjust to your preferences and project needs

Plugin Feature Comparison

Feature Basic Enhanced
Works with builds 163.15529 or newer, product version IDEA 2016.3.8 X X
Preview Tab so you can see what the rendered markdown will look like on GitHub. X X
Syntax highlighting X X
Table syntax highlighting stripes rows and columns X X
Support for Default and Darcula color schemes for preview tab X X
Warning and Error Annotations to help you validate wiki link errors X X
Link address completion for wiki links X X
Quick Fixes for detected wiki link errors X X
GFM Task list extension * [ ] open task item and * [x] completed task item X X
Line markers, Find usages, Go To Declaration for rapid navigation to wiki link targets X X
Markdown extensions configuration to customize markdown dialects X X
GitHub wiki support makes maintaining GitHub wiki pages easier. X X
GitHub compatible id generation for headers so you can validate your anchor references X X
Swing and JavaFX WebView based preview. X X
Supports JavaFX with JetBrains JRE on OS X X X
Supports Highlight JS in WebView preview X X
Multi-line Image URLs for embedding UML or LaTeX diagrams into markdown X X
Live Templates for common markdown elements X X
Split Editor with Preview or HTML Text modes to view both source and preview X X
Enhanced Version Benefits X
    Toolbar for fast access to frequent operations X
    Language Injections for fenced code, HTML, Jekyll front matter and multi-line URL content X
    Code completions, refactoring, annotations and quick fixes to let you work faster X
    Navigation support with Line markers, Find usages, Go To Declaration for rapid navigation X
    Inspections to help you validate links, anchor refs, footnote refs X
    Complete GitHub wiki support for all links makes maintaining GitHub wiki pages a breeze X
    Jekyll front matter recognition in markdown documents X
    Emoji text to icon conversion using Emoji Cheat Sheet or GitHub emoji URLs X
    Wrap on typing and table formatting with column alignment X
    Character display width used for wrapping and table formatting X
    Structure view for Abbreviations, Headers, Tables, Footnotes, References and Document X
    Document formatting with text wrapping, list renumbering, aranging of elements, etc. X
    Table of Contents generation for any markdown parser, with many style options X
    Copy/paste references and links between files will adjust the link address to the destination file X
    Paste Images from clipboard to create a link and save image file with optional image manipulation X
    Drag and Drop files from project tree into markdown documents to create links X
    Quickly find preview elements: element at caret highlight, search and selection display in preview X
As you type automation X
    Double of bold/emphasis markers and remove inserted ones if a space is typed X
    Wrap text blocks to margins and indentation X
    ATX headers to match trailing # marker X
    Setext headers to match marker length to text X
    Format tables to pad column width, column alignment and spanning columns X
    Auto insert empty table row on ENTER X
    Auto delete empty table row/column on BACKSPACE X
    Auto insert table column when typing before first column or after last column of table X
    Actions to insert: table, row or column; delete: row or column X
    Auto insert list item on ENTER X
    Auto delete empty list item on ENTER X
    Auto delete empty list item on BACKSPACE X
    Indent or un-indent list item toolbar buttons and actions X
    Tab/Backtab for table navigation and list indent/unindent actions X
    Move Table Column left/right actions X
    HTML Paste Options to suppress generation of some markdown elements X
    HTML comment folding and options X
    Join Lines with prefix removal X
Code Completions X
    Absolute link address completions using https:// and file:// formats X
    Explicit and Image links are GitHub wiki aware X
    GitHub Issue # Completions after issues/ link address and in text X
    GitHub special links: Issues, Pull requests, Graphs, and Pulse. X
    Link address completions for non-markdown files X
    Emoji text shortcuts completion X
    Java module, class, field and method completions in inline code elements X
    Anchor ref completions for remote links X
Intention Actions X
    Change between relative and absolute https:// link addresses via intention action X
    Change between wiki links and explicit link X
    Intentions for links, wiki links, references and headers X
    Intention to format Setext Header marker to match marker length to text X
    Intention to swap Setext/Atx header format X
    Update table of contents quick fix intention X
    Intention to edit Table of Contents style options dialog with preview X
Refactoring X
    Automatic change from wiki link to explicit link when link target file is moved out of the wiki X
    File move refactoring of contained links. This completes the refactoring feature set X
    Refactoring for /, https:// and file:// absolute link addresses to project files X
    Refactoring of header text with update to referencing anchor link references X
    Anchor link reference refactoring with update to referenced header text X
    Anchor link reference explorer for project wide anchor ref search X
Markdown Extensions X
    Admonition, based on Admonition Extension, Material for MkDocs X
    Attributes X
    Enumerated References X
    Footnotes X
    Table of Contents X
    GitLab Flavoured Markdown X

Release Road Map

Next Version 2.7.0

Bug and compatibility fixes you can find in Version Notes.

Install EAP plugin version to preview next release.

  • Option to enable validation of remote links (annotates unresolved link if server returns error)
  • Error annotation for links to HTML files in project with anchor refs which do not link to a or h1 through h6 html tags with name or id attribute given by anchor ref
  • Anchor link completion for links to HTML files in project to a or h1 through h6 html tags with name or id attribute giving the anchor ref
  • Anchor link completion on external URLs which do not resolve to a project file.
    • Special handling if file extension matches a Markdown Language extension, will download the markdown file and will render it as HTML to extract anchor definitions
    • Special handling for GitHub (ones starting with http:// or https:// followed by
      • markdown files: If the link is to a blob type then will use raw type URL to get Markdown so it can be correctly rendered as HTML to extract anchor definitions.
      • html content:
        • remove user-content- prefix from anchor refs (GitHub adds these automatically)
        • remove [0-9a-fA-F]{32}-[0-9a-fA-F]{40} looking anchor ids
    • Special handling for GitLab (ones starting with http:// or https:// followed by
      • markdown files: If the link is to a blob type then will use raw type URL to get Markdown so it can be correctly rendered as HTML to extract anchor definitions.
      • html content:
        • remove [0-9a-fA-F]{32}-[0-9a-fA-F]{40} looking anchor ids

Version 2.6.0

Bug and compatibility fixes you can find in Version Notes.

  • Add: Join Lines option to Remove Prefixes
  • Fix: style changes are now highlighted to properly reflect the last change, not whole document reformat changes
  • Add: GitLab Flavoured Markdown extensions
    • Math inline using $``$ and fenced code blocks with info of math using Katex
    • Chart fenced code blocks with info of mermaid using Mermaid
    • Inserted text (underlined) via {+text+} or [+text+]
    • Deleted text (strike through) via {-text-} or [-text-]
    • Multiline block quotes using >>> at start of line to mark block start and <<< at start of line to mark block end. GFM: Multiline Blockquote
    • Video image link rendering GFM: Videos
  • Add: Tab/Backtab overrides for table navigation and list indent/unindent actions
  • Add: Move Table Column left/right actions
  • Add HTML Paste Options to suppress generation of some markdown elements
  • Add: HTML comment folding and options

Version 2.5.2

  • Support for IDE versions 2016.3.8 or newer. Older IDEs can only use plugin version 2.4.0 and older.
  • Vertical Split text/preview option
  • Text/Preview toggle action option
  • <a name=""> anchor targets implemented
  • Attributes Parser extension
  • Enumerated References Parser extension
  • Admonition, Parser extension based on Admonition Extension, Material for MkDocs
  • Settings management: Copy project settings to/from project defaults and import/export project settings.
  • Copy Markdown Navigator project settings to/from Project Defaults
  • Directories now recognized in link targets
  • Project Ref Anchor explorer intention
  • Google Chrome Dev Tools for JavaFX WebView script debugging.

Version 2.4.0

Bug and compatibility fixes.

  • Navigate using links with GitHub Line Reference anchor refs
  • Copy Reference then Paste to get link with line reference
  • Encode/Decode Base64 Images Intention
  • Paste Images with Base64 Encoded embedded image links
  • Embed Images HTML generation option
  • Base64 embedded image display in Swing browser
  • Convert Markdown to HTML intention for fenced code elements
  • Code Folding option in settings for embedded image links

Version 2.3.8

Bug and compatibility fixes.

  • Add GitHub Line reference anchors in the form L# or L#-L# for line ranges. Now navigating to such an anchor in a project file will move the caret to the line and if second form is used select the lines.
  • Add clicking on task item box in preview toggles open/closed task status in source (JavaFX browser).
  • Add Apply all '...' in file intentions where these make sense.
  • Add intention to convert between typographic symbols and markdown smarts/quotes extension text.
  • Add HTML block deep parsing parser option to allow better handling of raw text tag parsing when they are not the first tag on the first line of the block.
  • Add Launching external URLs inside the browser, now navigate to declaration opens url in browser, ftp or mail client depending on the link. Can also use line markers for navigation of these elements.
  • Add GitBook compatible include tags when GitBook compatibility mode is enabled in Parser options.
  • Add handling of optional quotes for jekyll include tags. Either single ' or double " quotes will be ignored if the file name is wrapped in them.
  • Add Insert table column on right actions and changed description of previous action to insert table column on left.
  • Add #411, Network drives links are not resolved correctly, URI links outside of project now error highlighted if the file does not exist
  • Add #433, Support external links for the Link Map (eg. JIRA link), Reference to Link Map to allow creating automatic reference URLs from Reference IDs
  • Fix HTML generation with line source line highlighting when inline styling spans source lines
  • Fix #459, PDF export does not resolve local ref anchors
  • Fix #456, Register r markdown code chunk prefix
  • Fix #453, Option to hide toolbar
  • Fix breadcrumb tooltip of task items would be missing the task item marker
  • Fix #447, Exported HTML has unexpected CSS and JS URLs
  • Fix #445, there should no be default language injection in bare code chunks
  • Fix #444, Markdown Navigator 2.3.7 breaks paste of github checkout url
  • Fix #441, false positive typo annotation in header, caused by using IdentifierSplitter instead of TextSplitter to handle elements that can have references.
  • Fix #442, Image Paste in Windows always pastes absolute file:// regardless of selection
  • Fix #440, Auto links should not appear in fenced code

Buy License via PayPal Get Trial License

For Bug Reports, Issues, Questions and Feature requests: GitHub Issues. Plugin documentation: GitHub Wiki