https://github.com/paradox460/djot
A fast Djot parser for Elixir
https://github.com/paradox460/djot
djot elixir markup
Last synced: 4 months ago
JSON representation
A fast Djot parser for Elixir
- Host: GitHub
- URL: https://github.com/paradox460/djot
- Owner: paradox460
- License: mit
- Created: 2023-11-09T01:17:01.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2025-07-24T05:30:01.000Z (11 months ago)
- Last Synced: 2025-10-21T15:07:45.732Z (8 months ago)
- Topics: djot, elixir, markup
- Language: Elixir
- Size: 59.6 KB
- Stars: 18
- Watchers: 1
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-djot - paradox460/djot - Elixir wrapper around jotdown. (Parsers & Libraries / Elixir)
README
# Djot
[](https://hex.pm/packages/djot)
A fast [Djot](https://djot.net) parser and formatter for Elixir.
Djot parsing and transformations powered by the [jotdown](https://crates.io/crates/jotdown) rust crate.
## Usage
Simply call `to_html` on a string that contains Djot data, and you'll get back a html fragment.
```elixir
Djot.to_html("hello *world*!")
# => {:ok, "
hello world!
\n"}
```
### Sigil
If you want to write Djot contents inline in an Elixir program, you can use the provided sigil
```elixir
import Djot.Sigil
~d"""
This is a Djot document. \
It will be compiled to HTML automatically, at compile time!
Here's some display math, thank you djot!
$$`
\frac{-b \pm \sqrt{b^2 - 4 a c}}{2 a}
`
"""
# => "
This is a Djot document.
\nIt will be compiled to HTML automatically, at compile time!
\n\\[\n\\frac{-b \\pm \\sqrt{b^2 - 4 a c}}{2 a}\n\\]
\n"
```
This can be useful when paired with tools such as the [Tableau SSG](https://github.com/elixir-tools/tableau)
### Options
The Djot renderer accepts a few options:
| Option | Values | Description |
| ---------------------- | ------------------------------------ | ------------------------------------------------------------------------ |
| `renderer` | `:default`, `:minified`, `:indented` | Which particular output renderer to use |
| `indent_string` | String | String which is used to indent lines when using the `:indented` renderer |
| `indent_initial_level` | Integer | How deep the initial indent starts at |
These are passed to the `Djot.to_html` calls as follows:
```elixir
Djot.to_html(document, renderer: :indented, indent_string: " ", initial_indent_level: 1)
```
If you are using the bang variant of `to_html/2`, substitute it where appropriate
## Installation
Add `:djot` as a dependency:
```elixir
def deps do
[
{:djot, "~> 0.1.0"}
]
```
## See Also
If you want something that runs on _pure BEAM_ code, checkout [jot](https://hex.pm/packages/jot), written in Gleam.
This package is inspired by the excellent [mdex](https://hex.pm/packages/mdex) package.
There is no syntax highlighting out of the box with this package. If you want server-side highlighting, I recommend [autumn](https://hex.pm/packages/autumn).