├── .github └── workflows │ └── clojure.yml ├── .gitignore ├── LICENSE ├── README.md ├── project.clj ├── src └── commonmark_hiccup │ └── core.clj └── test └── commonmark_hiccup └── core_test.clj /.github/workflows/clojure.yml: -------------------------------------------------------------------------------- 1 | name: Clojure CI 2 | 3 | on: 4 | push: 5 | branches: [ master ] 6 | pull_request: 7 | branches: [ master ] 8 | 9 | jobs: 10 | build: 11 | 12 | runs-on: ubuntu-latest 13 | 14 | steps: 15 | - uses: actions/checkout@v2 16 | - name: Install dependencies 17 | run: lein deps 18 | - name: Run tests 19 | run: lein test 20 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | /target 2 | /classes 3 | /checkouts 4 | pom.xml 5 | pom.xml.asc 6 | *.jar 7 | *.class 8 | /.lein-* 9 | /.nrepl-port 10 | .hgignore 11 | .hg/ 12 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | THE ACCOMPANYING PROGRAM IS PROVIDED UNDER THE TERMS OF THIS ECLIPSE PUBLIC 2 | LICENSE ("AGREEMENT"). ANY USE, REPRODUCTION OR DISTRIBUTION OF THE PROGRAM 3 | CONSTITUTES RECIPIENT'S ACCEPTANCE OF THIS AGREEMENT. 4 | 5 | 1. DEFINITIONS 6 | 7 | "Contribution" means: 8 | 9 | a) in the case of the initial Contributor, the initial code and 10 | documentation distributed under this Agreement, and 11 | 12 | b) in the case of each subsequent Contributor: 13 | 14 | i) changes to the Program, and 15 | 16 | ii) additions to the Program; 17 | 18 | where such changes and/or additions to the Program originate from and are 19 | distributed by that particular Contributor. A Contribution 'originates' from 20 | a Contributor if it was added to the Program by such Contributor itself or 21 | anyone acting on such Contributor's behalf. Contributions do not include 22 | additions to the Program which: (i) are separate modules of software 23 | distributed in conjunction with the Program under their own license 24 | agreement, and (ii) are not derivative works of the Program. 25 | 26 | "Contributor" means any person or entity that distributes the Program. 27 | 28 | "Licensed Patents" mean patent claims licensable by a Contributor which are 29 | necessarily infringed by the use or sale of its Contribution alone or when 30 | combined with the Program. 31 | 32 | "Program" means the Contributions distributed in accordance with this 33 | Agreement. 34 | 35 | "Recipient" means anyone who receives the Program under this Agreement, 36 | including all Contributors. 37 | 38 | 2. GRANT OF RIGHTS 39 | 40 | a) Subject to the terms of this Agreement, each Contributor hereby grants 41 | Recipient a non-exclusive, worldwide, royalty-free copyright license to 42 | reproduce, prepare derivative works of, publicly display, publicly perform, 43 | distribute and sublicense the Contribution of such Contributor, if any, and 44 | such derivative works, in source code and object code form. 45 | 46 | b) Subject to the terms of this Agreement, each Contributor hereby grants 47 | Recipient a non-exclusive, worldwide, royalty-free patent license under 48 | Licensed Patents to make, use, sell, offer to sell, import and otherwise 49 | transfer the Contribution of such Contributor, if any, in source code and 50 | object code form. This patent license shall apply to the combination of the 51 | Contribution and the Program if, at the time the Contribution is added by the 52 | Contributor, such addition of the Contribution causes such combination to be 53 | covered by the Licensed Patents. The patent license shall not apply to any 54 | other combinations which include the Contribution. No hardware per se is 55 | licensed hereunder. 56 | 57 | c) Recipient understands that although each Contributor grants the licenses 58 | to its Contributions set forth herein, no assurances are provided by any 59 | Contributor that the Program does not infringe the patent or other 60 | intellectual property rights of any other entity. Each Contributor disclaims 61 | any liability to Recipient for claims brought by any other entity based on 62 | infringement of intellectual property rights or otherwise. As a condition to 63 | exercising the rights and licenses granted hereunder, each Recipient hereby 64 | assumes sole responsibility to secure any other intellectual property rights 65 | needed, if any. For example, if a third party patent license is required to 66 | allow Recipient to distribute the Program, it is Recipient's responsibility 67 | to acquire that license before distributing the Program. 68 | 69 | d) Each Contributor represents that to its knowledge it has sufficient 70 | copyright rights in its Contribution, if any, to grant the copyright license 71 | set forth in this Agreement. 72 | 73 | 3. REQUIREMENTS 74 | 75 | A Contributor may choose to distribute the Program in object code form under 76 | its own license agreement, provided that: 77 | 78 | a) it complies with the terms and conditions of this Agreement; and 79 | 80 | b) its license agreement: 81 | 82 | i) effectively disclaims on behalf of all Contributors all warranties and 83 | conditions, express and implied, including warranties or conditions of title 84 | and non-infringement, and implied warranties or conditions of merchantability 85 | and fitness for a particular purpose; 86 | 87 | ii) effectively excludes on behalf of all Contributors all liability for 88 | damages, including direct, indirect, special, incidental and consequential 89 | damages, such as lost profits; 90 | 91 | iii) states that any provisions which differ from this Agreement are offered 92 | by that Contributor alone and not by any other party; and 93 | 94 | iv) states that source code for the Program is available from such 95 | Contributor, and informs licensees how to obtain it in a reasonable manner on 96 | or through a medium customarily used for software exchange. 97 | 98 | When the Program is made available in source code form: 99 | 100 | a) it must be made available under this Agreement; and 101 | 102 | b) a copy of this Agreement must be included with each copy of the Program. 103 | 104 | Contributors may not remove or alter any copyright notices contained within 105 | the Program. 106 | 107 | Each Contributor must identify itself as the originator of its Contribution, 108 | if any, in a manner that reasonably allows subsequent Recipients to identify 109 | the originator of the Contribution. 110 | 111 | 4. COMMERCIAL DISTRIBUTION 112 | 113 | Commercial distributors of software may accept certain responsibilities with 114 | respect to end users, business partners and the like. While this license is 115 | intended to facilitate the commercial use of the Program, the Contributor who 116 | includes the Program in a commercial product offering should do so in a 117 | manner which does not create potential liability for other Contributors. 118 | Therefore, if a Contributor includes the Program in a commercial product 119 | offering, such Contributor ("Commercial Contributor") hereby agrees to defend 120 | and indemnify every other Contributor ("Indemnified Contributor") against any 121 | losses, damages and costs (collectively "Losses") arising from claims, 122 | lawsuits and other legal actions brought by a third party against the 123 | Indemnified Contributor to the extent caused by the acts or omissions of such 124 | Commercial Contributor in connection with its distribution of the Program in 125 | a commercial product offering. The obligations in this section do not apply 126 | to any claims or Losses relating to any actual or alleged intellectual 127 | property infringement. In order to qualify, an Indemnified Contributor must: 128 | a) promptly notify the Commercial Contributor in writing of such claim, and 129 | b) allow the Commercial Contributor to control, and cooperate with the 130 | Commercial Contributor in, the defense and any related settlement 131 | negotiations. The Indemnified Contributor may participate in any such claim 132 | at its own expense. 133 | 134 | For example, a Contributor might include the Program in a commercial product 135 | offering, Product X. That Contributor is then a Commercial Contributor. If 136 | that Commercial Contributor then makes performance claims, or offers 137 | warranties related to Product X, those performance claims and warranties are 138 | such Commercial Contributor's responsibility alone. Under this section, the 139 | Commercial Contributor would have to defend claims against the other 140 | Contributors related to those performance claims and warranties, and if a 141 | court requires any other Contributor to pay any damages as a result, the 142 | Commercial Contributor must pay those damages. 143 | 144 | 5. NO WARRANTY 145 | 146 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, THE PROGRAM IS PROVIDED ON 147 | AN "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, EITHER 148 | EXPRESS OR IMPLIED INCLUDING, WITHOUT LIMITATION, ANY WARRANTIES OR 149 | CONDITIONS OF TITLE, NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A 150 | PARTICULAR PURPOSE. Each Recipient is solely responsible for determining the 151 | appropriateness of using and distributing the Program and assumes all risks 152 | associated with its exercise of rights under this Agreement , including but 153 | not limited to the risks and costs of program errors, compliance with 154 | applicable laws, damage to or loss of data, programs or equipment, and 155 | unavailability or interruption of operations. 156 | 157 | 6. DISCLAIMER OF LIABILITY 158 | 159 | EXCEPT AS EXPRESSLY SET FORTH IN THIS AGREEMENT, NEITHER RECIPIENT NOR ANY 160 | CONTRIBUTORS SHALL HAVE ANY LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, 161 | SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING WITHOUT LIMITATION 162 | LOST PROFITS), HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 163 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 164 | ARISING IN ANY WAY OUT OF THE USE OR DISTRIBUTION OF THE PROGRAM OR THE 165 | EXERCISE OF ANY RIGHTS GRANTED HEREUNDER, EVEN IF ADVISED OF THE POSSIBILITY 166 | OF SUCH DAMAGES. 167 | 168 | 7. GENERAL 169 | 170 | If any provision of this Agreement is invalid or unenforceable under 171 | applicable law, it shall not affect the validity or enforceability of the 172 | remainder of the terms of this Agreement, and without further action by the 173 | parties hereto, such provision shall be reformed to the minimum extent 174 | necessary to make such provision valid and enforceable. 175 | 176 | If Recipient institutes patent litigation against any entity (including a 177 | cross-claim or counterclaim in a lawsuit) alleging that the Program itself 178 | (excluding combinations of the Program with other software or hardware) 179 | infringes such Recipient's patent(s), then such Recipient's rights granted 180 | under Section 2(b) shall terminate as of the date such litigation is filed. 181 | 182 | All Recipient's rights under this Agreement shall terminate if it fails to 183 | comply with any of the material terms or conditions of this Agreement and 184 | does not cure such failure in a reasonable period of time after becoming 185 | aware of such noncompliance. If all Recipient's rights under this Agreement 186 | terminate, Recipient agrees to cease use and distribution of the Program as 187 | soon as reasonably practicable. However, Recipient's obligations under this 188 | Agreement and any licenses granted by Recipient relating to the Program shall 189 | continue and survive. 190 | 191 | Everyone is permitted to copy and distribute copies of this Agreement, but in 192 | order to avoid inconsistency the Agreement is copyrighted and may only be 193 | modified in the following manner. The Agreement Steward reserves the right to 194 | publish new versions (including revisions) of this Agreement from time to 195 | time. No one other than the Agreement Steward has the right to modify this 196 | Agreement. The Eclipse Foundation is the initial Agreement Steward. The 197 | Eclipse Foundation may assign the responsibility to serve as the Agreement 198 | Steward to a suitable separate entity. Each new version of the Agreement will 199 | be given a distinguishing version number. The Program (including 200 | Contributions) may always be distributed subject to the version of the 201 | Agreement under which it was received. In addition, after a new version of 202 | the Agreement is published, Contributor may elect to distribute the Program 203 | (including its Contributions) under the new version. Except as expressly 204 | stated in Sections 2(a) and 2(b) above, Recipient receives no rights or 205 | licenses to the intellectual property of any Contributor under this 206 | Agreement, whether expressly, by implication, estoppel or otherwise. All 207 | rights in the Program not expressly granted under this Agreement are 208 | reserved. 209 | 210 | This Agreement is governed by the laws of the State of New York and the 211 | intellectual property laws of the United States of America. No party to this 212 | Agreement will bring a legal action under this Agreement more than one year 213 | after the cause of action arose. Each party waives its rights to a jury trial 214 | in any resulting litigation. 215 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # commonmark-hiccup 2 | 3 | ![build](https://github.com/bitterblue/commonmark-hiccup/actions/workflows/clojure.yml/badge.svg) 4 | 5 | A small Clojure library for converting [CommonMark][1] markdown to HTML. It is 6 | designed to make the HTML output as configurable as possible, relying 7 | on [Hiccup][2] as an intermediary representation. 8 | 9 | [1]: http://spec.commonmark.org/ 10 | [2]: https://github.com/weavejester/hiccup 11 | 12 | 13 | ## Installation 14 | 15 | Add the following dependency to `project.clj`: 16 | 17 | [commonmark-hiccup "0.2.0"] 18 | 19 | 20 | ## Documentation 21 | 22 | commonmark-hiccup uses the [commonmark-java][3] parser and implements its own 23 | renderer, which transforms the CommonMark AST to Hiccup-compatible Clojure data 24 | structures. It then uses Hiccup to render them to their final HTML 25 | representation. 26 | 27 | commonmark-hiccup is built for configurability, not performance. I use it to 28 | render static content for different web sites, each with different requirements 29 | for how paragraphs, code blocks etc. should look like. 30 | 31 | [3]: https://github.com/atlassian/commonmark-java 32 | 33 | 34 | ### Usage 35 | 36 | You can convert a markdown string to HTML using `markdown->html`: 37 | 38 | ```clojure 39 | user=> (require '[commonmark-hiccup.core :refer [markdown->html]]) 40 | nil 41 | user=> (markdown->html "This is a *test*.") 42 | "

This is a test.

" 43 | 44 | ``` 45 | 46 | You can pass a configuration to the converter to tweak the output. This example 47 | renders paragraphs without the surrounding `

` tags: 48 | 49 | ```clojure 50 | user=> (let [config (update-in commonmark-hiccup.core/default-config 51 | [:renderer :nodes org.commonmark.node.Paragraph] 52 | (constantly :content))] 53 | (markdown->html config "This is a *test*.")) 54 | "This is a test." 55 | ``` 56 | 57 | ### Configuration 58 | 59 | The default configuration defines the Hiccup snippets to which the different 60 | CommonMark AST nodes are rendered: 61 | 62 | ```clojure 63 | (def default-config 64 | {:renderer {:nodes {org.commonmark.node.Document :content 65 | org.commonmark.node.Heading ['(:h :node-level) :content] 66 | org.commonmark.node.Paragraph [:p :content] 67 | org.commonmark.node.Text :node-literal 68 | org.commonmark.node.BulletList [:ul :content] 69 | org.commonmark.node.OrderedList [:ol {:start :node-startNumber} :content] 70 | org.commonmark.node.ListItem [:li :content] 71 | org.commonmark.node.BlockQuote [:blockquote :content] 72 | org.commonmark.node.HtmlBlock :node-literal 73 | org.commonmark.node.HtmlInline :node-literal 74 | org.commonmark.node.FencedCodeBlock [:pre [:code {:class :node-info} :node-literal]] 75 | org.commonmark.node.IndentedCodeBlock [:pre [:code :node-literal]] 76 | org.commonmark.node.Code [:code :node-literal] 77 | org.commonmark.node.Link [:a {:href :node-destination} :content] 78 | org.commonmark.node.Image [:img {:src :node-destination 79 | :alt :text-content 80 | :title :node-title}] 81 | org.commonmark.node.Emphasis [:em :content] 82 | org.commonmark.node.StrongEmphasis [:strong :content] 83 | org.commonmark.node.ThematicBreak [:hr] 84 | org.commonmark.node.SoftLineBreak " " 85 | org.commonmark.node.HardLineBreak [:br]}} 86 | :parser {:extensions nil}}) 87 | ``` 88 | 89 | The `:nodes` map uses [commonmark-java][3] node classes as keys. The values are 90 | just Clojure data structures. Some keywords and lists are replaced during 91 | rendering: 92 | 93 | * All keywords prefixed with `:node-` are replaced with the respective property 94 | of the rendered node (e.g. `:node-literal` for `org.commonmark.node.HtmlBlock` 95 | is replaced with the value returned by `HtmlBlock::getLiteral`). 96 | * Some keywords are special: `:content` is replaced with the rendered content 97 | of the current node's children; `:text-content` is replaced with the 98 | concatenated content of all `org.commonmark.node.Text` child nodes. 99 | * List elements are joined to strings. This is useful for rendering node 100 | properties as part of a longer string. `['(:h :node-level) :content]` 101 | uses the `level` property of the `Heading` node to render the appropriate HTML 102 | tag (e.g. `

` for level 1 headings). 103 | 104 | For the available properties for each node type, refer to 105 | the [commonmark-java][3] sources. 106 | 107 | 108 | #### Extensions 109 | 110 | CommonMark [extensions](https://github.com/commonmark/commonmark-java#extensions) 111 | can be added to the parser by including them in the `[:parser :extensions]` 112 | list. 113 | 114 | For example, to add the support for GFM tables: 115 | 116 | 1. Add the dependency to your project 117 | ```clojure 118 | [com.atlassian.commonmark/commonmark-ext-gfm-tables "..."] 119 | ``` 120 | 121 | 2. Add the extension to your config along with the new renderers 122 | ```clojure 123 | (require '[commonmark-hiccup.core :as md]) 124 | (def my-config 125 | (-> md/default-config 126 | (update-in [:parser :extensions] conj 127 | (org.commonmark.ext.gfm.tables.TablesExtension/create)) 128 | (update-in [:renderer :nodes] merge 129 | {org.commonmark.ext.gfm.tables.TableBlock [:table :content] 130 | org.commonmark.ext.gfm.tables.TableHead [:thead :content] 131 | org.commonmark.ext.gfm.tables.TableBody [:tbody :content] 132 | org.commonmark.ext.gfm.tables.TableRow [:tr :content] 133 | org.commonmark.ext.gfm.tables.TableCell [:td :content]}))) 134 | 135 | (md/markdown->hiccup mt-config "|head1|head2| 136 | |---|---| 137 | |foo|bar|") 138 | => ([:table 139 | ([:thead ([:tr ([:td ("head1")] [:td ("head2")])])] 140 | [:tbody ([:tr ([:td ("foo")] [:td ("bar")])])])]) 141 | ``` 142 | 143 | 144 | ## License 145 | 146 | Copyright © 2017 Axel Schüssler 147 | 148 | Distributed under the Eclipse Public License either version 1.0 or (at 149 | your option) any later version. 150 | 151 | -------------------------------------------------------------------------------- /project.clj: -------------------------------------------------------------------------------- 1 | (defproject commonmark-hiccup "0.3.0" 2 | :description "Library to render CommonMark markdown to customizable HTML." 3 | :url "https://github.com/bitterblue/commonmark-hiccup" 4 | :license {:name "Eclipse Public License" 5 | :url "http://www.eclipse.org/legal/epl-v10.html"} 6 | :dependencies [[org.clojure/clojure "1.10.0"] 7 | [com.atlassian.commonmark/commonmark "0.17.0"] 8 | [hiccup "1.0.5"]] 9 | :repositories [["releases" {:url "https://repo.clojars.org" 10 | :creds :gpg}]] 11 | :profiles {:dev {:dependencies [[com.atlassian.commonmark/commonmark-ext-gfm-tables "0.17.0"]]}}) 12 | -------------------------------------------------------------------------------- /src/commonmark_hiccup/core.clj: -------------------------------------------------------------------------------- 1 | (ns commonmark-hiccup.core 2 | "Library for converting markdown to HTML. Uses commonmark-java 3 | (https://github.com/atlassian/commonmark-java) for parsing and 4 | renders to hiccup (https://github.com/weavejester/hiccup) data 5 | structures. The renderer itself is quite configurable." 6 | (:require [hiccup.core :as hiccup] 7 | [clojure.walk :as walk]) 8 | (:import org.commonmark.parser.Parser)) 9 | 10 | (def default-config 11 | {:renderer {:nodes {org.commonmark.node.Document :content 12 | org.commonmark.node.Heading ['(:h :node-level) :content] 13 | org.commonmark.node.Paragraph [:p :content] 14 | org.commonmark.node.Text :node-literal 15 | org.commonmark.node.BulletList [:ul :content] 16 | org.commonmark.node.OrderedList [:ol {:start :node-startNumber} :content] 17 | org.commonmark.node.ListItem [:li :content] 18 | org.commonmark.node.BlockQuote [:blockquote :content] 19 | org.commonmark.node.HtmlBlock :node-literal 20 | org.commonmark.node.HtmlInline :node-literal 21 | org.commonmark.node.FencedCodeBlock [:pre [:code {:class :node-info} :node-literal]] 22 | org.commonmark.node.IndentedCodeBlock [:pre [:code :node-literal]] 23 | org.commonmark.node.Code [:code :node-literal] 24 | org.commonmark.node.Link [:a {:href :node-destination} :content] 25 | org.commonmark.node.Image [:img {:src :node-destination 26 | :alt :text-content 27 | :title :node-title}] 28 | org.commonmark.node.Emphasis [:em :content] 29 | org.commonmark.node.StrongEmphasis [:strong :content] 30 | org.commonmark.node.ThematicBreak [:hr] 31 | org.commonmark.node.SoftLineBreak " " 32 | org.commonmark.node.HardLineBreak [:br]}} 33 | :parser {:extensions nil}}) 34 | 35 | (defn- children 36 | "Returns a seq of the children of a commonmark-java AST node." 37 | [node] 38 | (take-while some? (iterate #(.getNext %) (.getFirstChild node)))) 39 | 40 | (defn- text-content 41 | "Recursively walks over the given commonmark-java AST node depth-first, 42 | extracting and concatenating literals from any text nodes it visits." 43 | [node] 44 | (->> (tree-seq (constantly true) children node) 45 | (filter #(instance? org.commonmark.node.Text %)) 46 | (map #(.getLiteral %)) 47 | (apply str))) 48 | 49 | (defn property-map [node] 50 | (into {} (for [[k v] (dissoc (bean node) :class)] 51 | [(keyword (str "node-" (name k))) v]))) 52 | 53 | (defmulti node-properties 54 | "Returns the map representation of a commonmark-java AST node. Property names 55 | are prefixed with \"node-\"." 56 | class) 57 | (defmethod node-properties :default [node] (property-map node)) 58 | (defmethod node-properties org.commonmark.node.FencedCodeBlock [node] 59 | (-> (property-map node) 60 | (update :node-literal hiccup.util/escape-html) 61 | (update :node-info not-empty))) 62 | (defmethod node-properties org.commonmark.node.IndentedCodeBlock [node] 63 | (update (property-map node) :node-literal hiccup.util/escape-html)) 64 | (defmethod node-properties org.commonmark.node.Code [node] 65 | (update (property-map node) :node-literal hiccup.util/escape-html)) 66 | (defmethod node-properties org.commonmark.node.OrderedList [node] 67 | (update (property-map node) :node-startNumber #(when (< 1 %) %))) 68 | (defmethod node-properties org.commonmark.node.ListItem [node] 69 | (let [parent (.getParent node) 70 | tight? (and (instance? org.commonmark.node.ListBlock parent) 71 | (.isTight parent))] 72 | (assoc (property-map node) :content (if tight? :content-tight :content)))) 73 | 74 | (defn- string-fuse 75 | "Takes a seq and joins its elements into a single string. If a keyword 76 | is in the first position, its name is used instead of the keyword itself." 77 | [s] 78 | (apply str (cons (name (first s)) (rest s)))) 79 | 80 | (defn- render-node [config node] 81 | (let [html-config (get-in config [:renderer :nodes (class node)]) 82 | render-children (fn [n] (map (partial render-node config) (children n)))] 83 | (->> html-config 84 | (walk/postwalk-replace (node-properties node)) 85 | (walk/postwalk #(if (= :content %) (render-children node) %)) 86 | (walk/postwalk #(if (= :content-tight %) (render-children (first (children node))) %)) 87 | (walk/postwalk #(if (= :text-content %) (text-content node) %)) 88 | (walk/postwalk #(if (list? %) (string-fuse %) %))))) 89 | 90 | (defn- parse-markdown 91 | [config s] 92 | (let [exts (seq (get-in config [:parser :extensions])) 93 | parser (cond-> (Parser/builder) 94 | exts (.extensions exts) 95 | true (.build))] 96 | (.parse parser s))) 97 | 98 | (defn markdown->hiccup 99 | "Takes a string of markdown and converts it to Hiccup. Optionally takes a configuration 100 | map, allowing customization of the Hiccup output." 101 | ([s] (markdown->hiccup default-config s)) 102 | ([config s] (render-node config (parse-markdown config s)))) 103 | 104 | (defn markdown->html 105 | "Takes a string of markdown and converts it to HTML. Optionally takes a configuration 106 | map, allowing customization of the HTML output." 107 | ([s] (markdown->html default-config s)) 108 | ([config s] (hiccup/html (markdown->hiccup config s)))) 109 | -------------------------------------------------------------------------------- /test/commonmark_hiccup/core_test.clj: -------------------------------------------------------------------------------- 1 | (ns commonmark-hiccup.core-test 2 | (:require [clojure.test :refer :all] 3 | [commonmark-hiccup.core :refer :all])) 4 | 5 | (deftest markdown->html-test 6 | (testing "converts a simple string of markdown to html" 7 | (are [md html] (= html (markdown->html md)) 8 | "Test. Test." "

Test. Test.

" 9 | "# Test\nTesting test." "

Test

Testing test.

" 10 | "## Second Level Heading" "

Second Level Heading

" 11 | "### Third Level Heading" "

Third Level Heading

" 12 | "#### 4th Level Heading" "

4th Level Heading

" 13 | "##### 5th Level Heading" "
5th Level Heading
" 14 | "###### 6th Level Heading" "
6th Level Heading
")) 15 | (testing "replaces line breaks within text contents with spaces by default" 16 | (is (= (markdown->html "This is a\nparagraph with line\nbreaks.") 17 | "

This is a paragraph with line breaks.

"))) 18 | (testing "renders reference links" 19 | (is (= (markdown->html "This is a [test][1].\n\n[1]: www.test.tst") 20 | "

This is a test.

"))) 21 | (testing "renders images" 22 | (are [md html] (= html (markdown->html md)) 23 | "![A pretty picture](./picture.png)" "

\"A

" 24 | "![A pretty picture](./picture.png \"A Title\")" "

\"A

" 25 | "![](./picture.png)" "

\"\"

")) 26 | (testing "renders fenced code blocks" 27 | (is (= (markdown->html "```\n(def foo \"bar\")\n```") 28 | "
(def foo "bar")\n
")) 29 | (is (= (markdown->html "```clojure\n(def foo \"bar\")\n```") 30 | "
(def foo "bar")\n
")) 31 | (let [config (update-in default-config 32 | [:renderer :nodes org.commonmark.node.FencedCodeBlock] 33 | (constantly [:pre {:class '("lang:" :node-info " decode:true")} :node-literal]))] 34 | (is (= (markdown->html config "```clojure\n(def foo \"bar\")\n```") 35 | "
(def foo "bar")\n
")))) 36 | (testing "renders indented code blocks" 37 | (is (= (markdown->html " (def foo \"bar\")") 38 | "
(def foo "bar")\n
"))) 39 | (testing "renders code spans" 40 | (is (= (markdown->html "Avoid throwing `NullPointerException` explicitly!") 41 | "

Avoid throwing NullPointerException explicitly!

")) 42 | (is (= (markdown->html "Inline code, e.g. ``, should be escaped.") 43 | "

Inline code, e.g. <script>alert('Test');</script>, should be escaped.

"))) 44 | (testing "renders emphasis and strong emphasis" 45 | (is (= (markdown->html "This is _emphasized_ text.") 46 | "

This is emphasized text.

")) 47 | (is (= (markdown->html "This is *emphasized* text.") 48 | "

This is emphasized text.

")) 49 | (is (= (markdown->html "This is **strongly emphasized** text.") 50 | "

This is strongly emphasized text.

"))) 51 | (testing "renders blockquotes" 52 | (is (= (markdown->html "> This is a\n> blockquote!") 53 | "

This is a blockquote!

"))) 54 | (testing "renders tight lists" 55 | (is (= (markdown->html "- foo\n- bar\n- baz") 56 | "")) 57 | (is (= (markdown->html "1. foo\n2. bar") 58 | "
  1. foo
  2. bar
")) 59 | (is (= (markdown->html "1. foo\n2. bar\n3) baz") 60 | "
  1. foo
  2. bar
  1. baz
"))) 61 | (testing "renders loose lists" 62 | (is (= (markdown->html "- foo\n\n- bar\n\n- baz") 63 | ""))) 64 | (testing "renders HTML blocks" 65 | (is (= (markdown->html "") 66 | ""))) 67 | (testing "renders inline HTML" 68 | (is (= (markdown->html "This is text surrounded by tags.") 69 | "

This is text surrounded by tags.

"))) 70 | (testing "renders thematic breaks" 71 | (is (= (markdown->html "---") 72 | "
"))) 73 | (testing "renders hard line breaks" 74 | (is (= (markdown->html "This is a\\\nline with\\\nhard line breaks.") 75 | "

This is a
line with
hard line breaks.

")))) 76 | 77 | (deftest commonmark-extensions-test 78 | (testing "renders tables" 79 | (let [config (-> default-config 80 | (update-in [:parser :extensions] conj 81 | (org.commonmark.ext.gfm.tables.TablesExtension/create)) 82 | (update-in [:renderer :nodes] merge 83 | {org.commonmark.ext.gfm.tables.TableBlock [:table :content] 84 | org.commonmark.ext.gfm.tables.TableHead [:thead :content] 85 | org.commonmark.ext.gfm.tables.TableBody [:tbody :content] 86 | org.commonmark.ext.gfm.tables.TableRow [:tr :content] 87 | org.commonmark.ext.gfm.tables.TableCell [:td :content]}))] 88 | (is (= (markdown->html config "|head1|head2|\n|---|---|\n|foo|bar|") 89 | "
head1head2
foobar
"))))) 90 | --------------------------------------------------------------------------------