Djot IntelliJ Plugin

June 10, 2026 · View on GitHub

Djot markup language support for JetBrains IDEs (PhpStorm, IntelliJ IDEA, WebStorm, etc.).

Features

Syntax highlighting via TextMate grammar
Live preview panel (split editor view)
IDE theme sync - preview follows dark/light mode
Code highlighting - syntax highlighting in code blocks (highlight.js)
Export to HTML - full Djot rendering via embedded djot.js
Live Templates - code snippets for common Djot patterns
Tool window for standalone preview
File type recognition for .djot files

Requirements

JetBrains IDE 2024.1+
Java 17+

Installation

From JetBrains Marketplace

In your IDE: Settings → Plugins → Marketplace
Search for "Djot"
Click Install

Or install directly: JetBrains Marketplace

From Disk (manual)

Download the latest release from GitHub Releases, or build it yourself:
```
./gradlew buildPlugin
```
In your IDE: Settings → Plugins → ⚙️ → Install Plugin from Disk
Select the djot-intellij-*.zip file (in build/distributions/ if built locally)
Restart the IDE

Usage

Open any .djot file
Editor opens in split view (editor + preview)
Preview updates live as you type
Right-click for "Export to HTML" option
Use Ctrl+Shift+D to toggle preview tool window

Live Templates

Type a prefix and press Tab to expand. Available templates:

Prefix	Description
`djh1`-`djh6`	Headings
`djb`, `dji`, `djc`	Bold, italic, code
`djhi`, `djsup`, `djsub`	Highlight, superscript, subscript
`djins`, `djdel`	Insert, delete
`djlink`, `djlinkref`, `djimg`	Links and images
`djcode`, `djraw`	Code blocks
`djquote`, `djdiv`, `djhr`	Blockquote, div, horizontal rule
`djul`, `djol`, `djtask`, `djdef`	Lists
`djtable`	Table
`djfn`, `djfndef`	Footnotes
`djmath`, `djmathblock`	Math
`djattr`, `djid`, `djspan`	Attributes
`djfront`	YAML frontmatter
`djcomment`	Comment block

Preview Rendering

The plugin supports two rendering engines, configurable via Settings > Tools > Djot:

djot.js (default)

Uses djot.js for accurate Djot rendering with:

Code syntax highlighting (highlight.js)
IDE theme synchronization (dark/light)
Task list checkboxes
Full Djot feature support
No additional dependencies required

php-djot (PHP CLI)

Uses php-collective/djot for rendering via PHP CLI:

Requires PHP installed on your system
Requires php-collective/djot installed in your project:
```
composer require php-collective/djot
```
Useful for consistency with PHP-based projects
Uses the package's vendor/bin/djot CLI when present, falling back to a built-in inline converter for older versions
Supports custom converter scripts

About Djot

Djot is a lightweight markup language created by John MacFarlane (creator of Pandoc). It improves on Markdown with:

Consistent, unambiguous parsing rules
Better syntax for highlights, super/subscript, attributes
No backtracking required during parsing

Development

Building, running, and the release/publishing process are documented in docs/development.md. For contributing (setup, project structure, grammar updates, testing), see CONTRIBUTING.md.