Weave

Glossa's Weave library defines an API for transforming documents written as trees of Clojure data into human-readable strings.

(:require '[dev.glossa.weave :as weave])

Development

NB: Review the scripts and deps.edn files for necessary aliases (not all of which are defined in this repo).

Please run the setup script to populate Git hooks:

$ ./script/setup

To work on the core Weave API:

$ ./script/dev

To work on the separate project that provides a plain Markdown output format implementation:

cd output/markdown-plain
../../script/dev

To run tests:

./script/test

To run everything that CI does:

./script/ci

TODO

• Consider issues of single-child vs. multi-child nodes and how IR evaluation only expects one child.
• Consider adding authoring helpers for specific Markdown flavors (e.g., header link munging)

License

Copyright © Daniel Gregoire, 2021

THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT.