nml/README.md
2024-08-13 19:18:10 +02:00

1.3 KiB

NML -- Not a markup language!

Currently a work in progress, expect features and fixes to arrive soon!

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 and is licensed under MIT.

The installation instructions can be found on latex2svg's repository.

Graphviz rendering

To render Graphviz graph (i.e [graph]...[/graph]), you need to install the dot program from Graphviz.

Lua kernels

To execute Lua kernels you need to install liblua version 5.4. Support for a statically linked Lua may be added in the future.

Compiling

cargo build --release --bin nml

Features roadmap

  • Paragraphs
  • LaTeX rendering
  • Graphviz rendering
  • Media
  • References
  • Navigation
  • Cross-Document references
  • Complete Lua api
  • Documentation
  • Table
  • LaTeX output
  • LSP

License

NML is licensed under the GNU AGPL version 3 or later. See LICENSE.md for more information. License for third-party dependencies can be accessed via cargo license