Not a Markup Language
Find a file
2024-10-24 09:54:52 +02:00
crates/auto-registry Update macro 2024-08-08 17:11:32 +02:00
docs Blockquote doc 2024-08-26 12:45:41 +02:00
src Reports refactor [2/2] 2024-10-24 09:54:52 +02:00
third Update docs & Trim latex2svg 2024-07-31 17:26:27 +02:00
.gitignore First commit 2024-04-10 12:42:24 +02:00
Cargo.lock Blockquotes style 2024-08-12 22:33:25 +02:00
Cargo.toml Fix unicode width 2024-10-20 09:03:17 +02:00
LICENSE.md Update Readme 2024-07-25 14:19:49 +02:00
README.md Cross-references 2024-08-13 19:18:10 +02:00
readme.nml Update Readme 2024-07-25 14:19:49 +02:00
style.css Update style 2024-08-28 15:08:09 +02:00

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