Liking cljdoc? Tell your friends :D

Weave

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

;; Git dep
{dev.glossa/weave
 {:git/url "https://gitlab.com/glossa/weave.git"
  :git/tag "v0.2.126"
  :git/sha "2a42b6198ed9bd2273b134ee0c50017881dd0467"}}

;; Maven dep at https://clojars.org/dev.glossa/weave
{dev.glossa/weave {:mvn/version "0.2.126"}}

No output format is provided as part of this library. Add Weave Markdown to your classpath to get simple Markdown output for (glossa.weave/weave your-doc)

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 start nREPL (bring your own :cider alias):

./script/dev

To run tests:

./script/test

To run everything that CI does:

./script/ci

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.

Can you improve this documentation?Edit on GitLab

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close