Djot () is a
lightweight markup language
A lightweight markup language (LML), also termed a simple or humane markup language, is a markup language with simple, unobtrusive syntax. It is designed to be easy to write using any generic text editor and easy to read in its raw form. Lightwei ...
that aims to improve on
CommonMark
Markdown is a lightweight markup language for creating formatted text using a plain-text editor. John Gruber and Aaron Swartz created Markdown in 2004 as a markup language that is appealing to human readers in its source code form. Markdown i ...
's syntax where it is complex and difficult to parse efficiently.
It was created in 2022 by
John MacFarlane
John is a common English name and surname:
* John (given name)
* John (surname)
John may also refer to:
New Testament
Works
* Gospel of John, a title often shortened to John
* First Epistle of John, often shortened to 1 John
* Second E ...
, the author of
Pandoc and a member of the CommonMark standardization group.
It derives most of its features from CommonMark, but includes a wider set of features, including description lists, footnotes, tables, several new kinds of inline formatting, math and smart punctuation.
The original
reference implementation is written in a
scripting language (
Lua
Lua or LUA may refer to:
Science and technology
* Lua (programming language)
* Latvia University of Agriculture
* Last universal ancestor, in evolution
Ethnicity and language
* Lua people, of Laos
* Lawa people, of Thailand sometimes referred t ...
), but the language is designed to parse efficiently, so it is very fast.
The code and documentation are released under the
MIT License.
Difference from CommonMark
Djot's syntax is similar to CommonMark's, but there are some differences.
Blank lines
CommonMark does not need blank lines around block-level elements, but Djot does.
Example:
Headings
Djot has no
setext (
= or
-) headings, only
ATX (
#) headings.
Example:
Emphasis
CommonMark uses single
* or
_ for emphasis, and double
* or
_ for strong emphasis. Djot uses single
_ for emphasis, and single
* for strong emphasis.
Example:
Links
Unlike CommonMark, Djot has no special syntax for adding a title to a link. A title can be added by using the general attribute syntax instead.
Example:
Examples
Implementations
Uses
* Starting from version 3.1.12,
Pandoc supports Djot as an input format and an output format.
References
External links
*
{{Document markup languages
Lightweight markup languages
Open formats