2024-07-25 14:20:55 +02:00
|
|
|
# NML -- Not a markup language!
|
|
|
|
|
|
2024-11-03 14:18:11 +01:00
|
|
|
Documentation is available [here](https://ef3d0c3e.github.io/nml/readme/Getting%20Started.html)
|
2024-07-25 14:20:55 +02:00
|
|
|
|
|
|
|
|
# Requirements
|
|
|
|
|
|
|
|
|
|
Some features requires external dependencies to work.
|
|
|
|
|
|
|
|
|
|
## LaTeX rendering for HTML
|
|
|
|
|
|
|
|
|
|
We ship a modified version of `latex2svg` by Matthias C. Hormann.
|
|
|
|
|
The modified program can be found in [third/latex2svg](third/latex2svg) and is licensed under MIT.
|
|
|
|
|
|
2024-07-26 20:01:10 +02:00
|
|
|
The installation instructions can be found on [latex2svg's repository](https://github.com/Moonbase59/latex2svg).
|
2024-07-25 14:20:55 +02:00
|
|
|
|
|
|
|
|
## Graphviz rendering
|
|
|
|
|
|
2024-07-26 20:01:10 +02:00
|
|
|
To render Graphviz graph (i.e `[graph]...[/graph]`),
|
|
|
|
|
you need to install the `dot` program from [Graphviz](https://graphviz.org/).
|
2024-07-25 14:20:55 +02:00
|
|
|
|
|
|
|
|
## Lua kernels
|
|
|
|
|
|
2024-11-03 14:12:43 +01:00
|
|
|
NML statically compiles liblua5.4 to use the lua features.
|
2024-07-25 14:20:55 +02:00
|
|
|
|
|
|
|
|
# Compiling
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
cargo build --release --bin nml
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
# Features roadmap
|
|
|
|
|
|
|
|
|
|
- [x] Paragraphs
|
|
|
|
|
- [x] LaTeX rendering
|
|
|
|
|
- [x] Graphviz rendering
|
|
|
|
|
- [x] Media
|
2024-08-13 19:18:10 +02:00
|
|
|
- [x] References
|
|
|
|
|
- [x] Navigation
|
|
|
|
|
- [x] Cross-Document references
|
2024-11-03 14:12:43 +01:00
|
|
|
- [x] LSP
|
2024-07-25 14:20:55 +02:00
|
|
|
- [ ] Complete Lua api
|
|
|
|
|
- [ ] Documentation
|
|
|
|
|
- [ ] Table
|
|
|
|
|
- [ ] LaTeX output
|
|
|
|
|
|
|
|
|
|
# License
|
|
|
|
|
|
|
|
|
|
NML is licensed under the GNU AGPL version 3 or later. See [LICENSE.md](LICENSE.md) for more information.
|
|
|
|
|
License for third-party dependencies can be accessed via `cargo license`
|
