Liking cljdoc? Tell your friends :D

Weave: Markdown Output

This library implements rudimentary Markdown output for Weave documents. This output format is designed for reading directly (e.g., at the REPL), so it does not support arbitrary tags or HTML output.

;; Git dep
{dev.glossa/weave-markdown
 {:git/url "https://gitlab.com/glossa/weave-markdown.git"
  :git/tag "v0.1.12"
  :git/sha "a62876a40e23df789f6876ba198ba07449cfd9ff"}}

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

Because this is Weave's default output format, no further configuration is required:

(require '[glossa.weave :as weave])
(weave/weave [:h1 "Markdown Output!"])

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