README
¶
Frundis
frundis is a tool for compiling documents written in the frundis language, a semantic markup language primarily intended for supporting authoring of novels, but also well suited for many other kinds of documents. The frundis tool can export documents to LaTeX, XHTML 5, EPUB, markdown and groff mom.
Install
To install the command line interpreter, you only need to have the go compiler installed (Go 1.16 or later required). There are no extra dependencies.
You can then build the intepreter with:
go install ./cmd/frundis
You may add $(go env GOPATH)/bin to your $PATH (for example export PATH="$PATH:$(go env GOPATH)/bin"), so that your shell can find the frundis
executable.
Alternatively, you may put the resulting binary in a custom location (usually in your $PATH) by using instead the following command:
go build -o /path/to/bin/frundis ./cmd/frundis
In both cases, you should now have a frundis executable somewhere. Type
frundis --help for a short summary of command-line usage, and see the man
pages and the FAQ for more help (see Links below).
Links
- Website of the project (including man pages, FAQ): on codeberg, on tuxfamily.
- Changelog of changes between releases.
Editor Support
There is a frundis-specific vim syntax file under doc/vim/. Others editors should do fine by using any built-in general mode for roff/nroff files.
Misc
The misc folder contains some utility scripts that may be useful.
Directories