Liking cljdoc? Tell your friends :D

cloj-md

cloj-md is a simple, light weight clojure library that supports markdown (MD) file creation The library supports the following MD constructs:

  • headlines
  • boldness
  • italics
  • bullets
  • numeric bullets
  • code snippets
  • inline code
  • line breaks
  • links
  • images
  • videos
  • block quotes We can also add other Markdown features as strings such as ^superscripts^ and tables then write into MD file. Other examples (apart from the content so far):

Example

This is a simple example Bold italics

  • point 1
  • point 2
  1. One
  2. Two

java is a lang

const s = '10'; 
console.log(s);

Some block quote....

ImageImage VideoVideos

BTW, the above content in this MD file is generated by the below code

(->
 (str
  (h 2 "cloj-md") (br)
  (b 'cloj-md) " is a simple, light weight " (i 'clojure) " library that supports markdown (MD) file creation" (br)
  "The library supports the following MD constructs:" (br)
  (bu "headlines") (br)
  (bu "boldness") (br)
  (bu "italics") (br)
  (bu "bullets") (br)
  (bu "numeric bullets") (br)
  (bu "code snippets") (br)
  (bu "inline code") (br)
  (bu "line breaks") (br)
  (bu "links") (br)
  (bu "images") (br)
  (bu "videos") (br)
  (bu "block quotes") (br)
  "We can also add other Markdown features as strings such as ^superscripts^ and " (<> 'tables) " then write into MD file." (br)
  "Other examples (apart from the content so far): " (br)

  (->
   (h 3 'Example) (br)
   (p "This is a simple example") (br)
   (b "Bold") (br)
   (i "italics") (br 3)
   (bu "point 1") (br)
   (bu "point 2") (br)
   ($ 1 "One") (br)
   ($ 2 "Two") (br 2)
   (p (str (<> "java") " is a lang")) (br)
   (<<>> 'javascript "const s = '10'; \nconsole.log(s);") (br)
   (>> "Some block quote....") (br 2)
   (b 'Image) (img "Image" "https://img.youtube.com/vi/R3tbVHlsKhs/3.jpg") (br)
   (b 'Video) (vid "Videos" "http://img.youtube.com/vi/R3tbVHlsKhs/1.jpg" "https://www.youtube.com/watch?v=R3tbVHlsKhs")))

 (write-into "README.md"))

Can you improve this documentation?Edit on GitHub

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

× close