ef3d0c3e/nml
1
1
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Not a Markup Language
34 commits 3 branches 0 tags 2 MiB
Rust 54.9%
HTML 43.3%
Python 1%
CSS 0.8%
Find a file
ef3d0c3e 08ae603106 Section References & Minor style adjustment
2024-07-30 16:40:14 +02:00
docs Section References & Minor style adjustment 2024-07-30 16:40:14 +02:00
src Section References & Minor style adjustment 2024-07-30 16:40:14 +02:00
third Update Readme 2024-07-25 14:19:49 +02:00
.gitignore First commit 2024-04-10 12:42:24 +02:00
Cargo.lock Added batch processing mode 2024-07-27 21:32:12 +02:00
Cargo.toml Added batch processing mode 2024-07-27 21:32:12 +02:00
LICENSE.md Update Readme 2024-07-25 14:19:49 +02:00
README.md Update 2024-07-26 20:01:10 +02:00
readme.nml Update Readme 2024-07-25 14:19:49 +02:00
style.css Section References & Minor style adjustment 2024-07-30 16:40:14 +02:00

README.md

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