Skip to content

[WIP] Pure CLJC library to transform back and forth between markdown and hiccup

License

Notifications You must be signed in to change notification settings

green-coder/hiccdown

Repository files navigation

hiccdown

CircleCI

Clojars Project Cljdoc badge Project chat Clojars download_badge

"Don't look up, look down !"

-- President Orlean

Hiccdown is a pure CLJC library designed to translate documents back and forth between the Markdown format, an AST data, and the Hiccup data structure.

Project status

The implementation is incomplete, do not use.

See the tests in test/spec_test.cljs to see what is working and what is not.

Features (wip)

Installation

Clojars Project

Usage (wip)

(require '[hiccdown.core :as hd])

;; Transform a markdown document into hiccup data.
(-> markdown-str hd/markdown->ast hd/ast->hiccup)

;; Same as above, in the other direction. (Not implemented yet)
(-> hiccup-data hd/hiccup->ast hd/ast->markdown)

Running the tests

Run npm i once, then:

./bin/kaocha --watch

Alternative Clojure(script) libs

In alphabetical order:

(Open an issue if you wish to have your library added to the list)

License

Copyright © 2022 Vincent Cantin

Distributed under the Eclipse Public License either version 1.0 or (at your option) any later version.

About

[WIP] Pure CLJC library to transform back and forth between markdown and hiccup

Topics

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages