nml/README.md
2024-11-03 14:18:11 +01:00

1.2 KiB

NML -- Not a markup language!

Documentation is available here

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

NML statically compiles liblua5.4 to use the lua features.

Compiling

cargo build --release --bin nml

Features roadmap

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

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