;; some sweet clojure code
(defn hello-earthling
"Greet an earthling in a believable way." (1)
[name]
(println "Hello earthling " (uppercase name))) (2)Liking cljdoc? Tell your friends :D
Test Asciidoc 1
Table of Contents
Introduction
A test asciidoc to exercise cljdoc formatting and features.
Formatting marks
I have a strong feeling that I might be headstrong.
I am under the impression that that you are thunderstruck by this example.
My code was encodeded.
I a super excited about this subroutine.
Code blocks
code-block-title
| 1 | a docstring comes before the arguments |
| 2 | check with an earthling if uppercasing is soothing |
Images
This local image should work on github and cljdoc. According to asciidoctor, images are resolved relative to the document.
Current value of imagesdir:
{imagesdir}
How about captions, do we display those nicely?
Test image caption
Admonitions
| Note that this note is a note. |
| Tip the scales with a tip. |
| Important things are said here. |
| Aren’t you a caution? |
| Warning to the wise. |
Tables
Asciidoc tables are quite full featured, here’s a simple one:
| Heading 1 | Heading 2 |
|---|---|
col1, row1 | col2, row1 |
col1, row2 | col2, row2 |
col1, row3 | col2, row3 |
col1, row4 | col2, row4 |
Here’s the same table with a title
| Heading 1 | Heading 2 |
|---|---|
col1, row1 | col2, row1 |
col1, row2 | col2, row2 |
And here’s a nested table example from asciidoctor user manual:
| Col 1 | Col 2 | ||||
|---|---|---|---|---|---|
Cell 1.1 | Cell 1.2 | ||||
Cell 2.1 | Cell 2.2
|
Links
These are links will go to cljdoc.org:
Can you improve this documentation?Edit on GitHub
cljdoc builds & hosts documentation for Clojure/Script libraries
Keyboard shortcuts
× close| Ctrl+k | Jump to recent docs |
| ← | Move to previous article |
| → | Move to next article |
| Ctrl+/ | Jump to the search field |