cljdoc-exerciser.core
Here we look at cljdoc features for APIs
Here we look at cljdoc features for APIs
exercise1clj
(exercise1 d e f)Will someone ever link to me?
Will someone ever link to me?
exercise2clj
(exercise2)A docstring can contain CommonMark formatted text.
Lists
- one
- two
- buckle
- my
- shoe
- my
- buckle
Blockquotes
A quote
a nested quote
a very nested quote
Paragraphs
If you want a paragraph to include a linebreak,
you can do that.
Tables
Tables are a CommonMark extension but supported by cljdoc
| Left | Centered | Right |
|---|---|---|
| lets | peanut butter | 100 |
| fill | and | 10 |
| this | pickles | 1 |
Code blocks
(defn exercise
"A docstring can contain CommonMark formatted text."
[]
(+ 4 5 6))
Links
An external link to the CommonMark website.
If referencing a cljdoc article, use relative syntax so that the link will work locally during local testing. For example: the cljdoc-exerciser CommonMark features article.
There is an awkwardness here. If viewing from GitHub, I'd probably want to see the article from the GitHub repo rather than the cljdoc rendered version.
Wikilinks
Wikilinks are a cljdoc extension and allow you to link to api functions. They only work in docstrings.
Let's link to the exercise1 function in this namespace.
**A docstring can contain CommonMark formatted text.**
**Lists**
1. one
2. two
- buckle
- my
- shoe
**Blockquotes**
> A quote
>> a nested quote
>>> a very nested quote
**Paragraphs**
If you want a paragraph to include a linebreak, \
you can do that.
**Tables**
Tables are a CommonMark extension but supported by cljdoc
| Left | Centered | Right |
|----------|:-------------:|------:|
| lets | peanut butter | 100 |
| fill | and | 10 |
| this | pickles | 1 |
**Code blocks**
```clojure
(defn exercise
"A docstring can contain CommonMark formatted text."
[]
(+ 4 5 6))
```
**Links**
An external link to [the CommonMark website](https://commonmark.org/).
If referencing a cljdoc article, use relative syntax so that the link will work locally during local testing.
For example: [the cljdoc-exerciser CommonMark features article](/d/lread/cljdoc-exerciser/CURRENT/doc/document-tests/commonmark-features).
There is an awkwardness here. If viewing from GitHub, I'd probably want to see the article from the GitHub repo rather
than the cljdoc rendered version.
**Wikilinks**
Wikilinks are a cljdoc extension and allow you to link to api functions.
They only work in docstrings.
Let's link to the [[exercise1]] function in this namespace.exercise3clj
(exercise3 x y z)Linking to images might be of interest, I suppose.
Will one of my local images show up? I certainly hope so.
An external image should work fine too:
Linking to images might be of interest, I suppose. Will one of my local images show up? I certainly hope so.  An external image should work fine too: 
exercise4clj
(exercise4 a b c)Using headings in a docstring might be ridiculous, but you can do it.
Heading 1
Heading 2
Heading 3
Heading 4
Heading 5
this is too much, I am heading home.
Using headings in a docstring might be ridiculous, but you can do it. # Heading 1 ## Heading 2 ### Heading 3 #### Heading 4 ##### Heading 5 this is too much, I am heading home.
cljdoc is a website building & hosting documentation for Clojure/Script libraries
× close