dmos 0.2.1

Djot HTML renderer with advanced features
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59

# DMOS - Djot Much Output Schnutification

DMOS is a thin layer over the [jotdown][jotdown] [Djot][djot] parser and
renderer. It adds the following features:

* **Syntax highlighting**
  * By default based on [syntect][syntect]
  * [inkjet][inkjet]/[tree-sitter][tree-sitter] availabe, (executable size will
    be **huge**, see their README)
* **Table of contents** generation with various options
* Adding **section anchors** to headings linking to themselves

[jotdown]: https://crates.io/crates/jotdown
[djot]: https://djot.net/
[syntect]: https://crates.io/crates/syntect
[inkjet]: https://crates.io/crates/inkjet
[tree-sitter]: https://tree-sitter.github.io/tree-sitter/

The anchors are a common technique to allow users to easily get the link to a
specific section. They are usually styled with CSS to only appear when hovering
over the heading. If you are viewing the HTML rendering of this document on
[sr.ht][srht] you can see a similar mechanism in action by hovering the mouse
over any section heading.

[srht]: https://git.sr.ht/~bitfehler/dmos

The [dmos][dmos] crate is a library, [dmos-cli][dmos-cli] is a thin CLI wrapper
around it.

[dmos]: https://crates.io/crates/dmos
[dmos-cli]: https://crates.io/crates/dmos-cli

## Usage

```
Usage: dmos [OPTIONS] [FILE]

Arguments:
  [FILE]  Read input from FILE instead of stdin

Options:
  -a, --anchor <ANCHOR>      Add anchors with text ANCHOR to headings
  -t, --title-only           Output first first-level heading and exit
      --toc                  Generate document with table of contents
  -T, --toc-only             Output table of contents and exit
      --toc-skip-title       Skip title (first heading) in table of contents
      --toc-prologue <HTML>  Prologue to the table of content listing [default: "<section class=\"toc\"><h3>Table of Contents</h3>"]
      --toc-epilogue <HTML>  Epilogue to the table of content listing [default: </section>]
  -h, --help                 Print help
  -V, --version              Print version
```

## Contact

Feel free to send questions, patches, or other feedback to my [public
inbox][inbox]. Inquiries about my mental well-being are justified, but please
keep them polite.

[inbox]: https://lists.sr.ht/~bitfehler/public-inbox