Liking cljdoc? Tell your friends :D

marginalia.html

Utilities for converting parse results into html.

Utilities for converting parse results into html.
raw docstring

*resources*clj

source

codes-to-htmlclj

(codes-to-html code-block)
source

cssclj

(css & rules)

Quick and dirty dsl for inline css rules, similar to hiccup.

ex. (css [:h1 {:color "blue"}] [:div.content p {:text-indent "1em"}])

-> h1 {color: blue;} div.content p {text-indent: 1em;}

Quick and dirty dsl for inline css rules, similar to hiccup.

ex. `(css [:h1 {:color "blue"}] [:div.content p {:text-indent "1em"}])`

-> `h1 {color: blue;} div.content p {text-indent: 1em;}`
sourceraw docstring

css-ruleclj

(css-rule rule)
source

dependencies-htmlclj

(dependencies-html deps & header-name)
source

docs-to-htmlclj

(docs-to-html docs)

Converts a docs section to html by threading each doc line through the forms outlined above.

ex. (docs-to-html [{:doc-text "# hello world!"} {:docstring-text "I'm a docstring!}])

-> "<h1>hello world!</h1><br />"

Converts a docs section to html by threading each doc line through the forms
outlined above.

ex. (docs-to-html [{:doc-text "# hello world!"} {:docstring-text "I'm a docstring!}])

->  `"<h1>hello world!</h1><br />"`
sourceraw docstring

floating-toc-cssclj

source

floating-toc-htmlclj

(floating-toc-html docs)
source

general-cssclj

source

groups-htmlclj

(groups-html props doc)
source

header-cssclj

source

header-htmlclj

(header-html project-info)
source

index-htmlclj

(index-html project-metadata docs)
source

inline-cssclj

(inline-css resource)
source

inline-jsclj

(inline-js resource)
source

(link-to-namespace namespace-name anchor? & attrs)

Creates an 'a' tag pointing to the namespace-name, either as an anchor (if anchor? is true) or as a link to a separate $namespace-name.html file. If attrs aren't empty, they are added to the resulting tag.

Creates an 'a' tag pointing to the `namespace-name`, either as an anchor (if
`anchor?` is true) or as a link to a separate `$namespace-name.html` file.
If `attrs` aren't empty, they are added to the resulting tag.
sourceraw docstring

(link-to-toc anchor?)

This is a hack, as in the case when anchor? is false, the link will contain a reference to toc.html which might not even exist.

This is a hack, as in the case when `anchor?` is false, the link will contain
a reference to `toc.html` which might not even exist.
sourceraw docstring

mdclj

(md s)

Markdown string to html converter. Translates strings like:

"# header!" -> "<h1>header!</h1>"

"## header!" -> "<h2>header!</h2>"

...

Markdown string to html converter. Translates strings like:

"# header!" -> `"<h1>header!</h1>"`

"## header!" -> `"<h2>header!</h2>"`

...
sourceraw docstring

mdpclj

source

opt-resources-htmlclj

(opt-resources-html project-info)

Generate script and link tags for optional external javascript and css.

Generate script and link tags for optional external javascript and css.
sourceraw docstring

page-templateclj

(page-template project-metadata opt-resources header toc content floating-toc)

Notice that we're inlining the css & javascript for SyntaxHighlighter (inline-js & inline-css) to be able to package the output as a single file (uberdoc if you will). It goes without saying that all this is WIP and will probably change in the future.

Notice that we're inlining the css & javascript for [SyntaxHighlighter](http://alexgorbatchev.com/SyntaxHighlighter/) (`inline-js`
& `inline-css`) to be able to package the output as a single file (uberdoc if you will).  It goes without
saying that all this is WIP and will probably change in the future.
sourceraw docstring

reset-cssclj

source

section-to-htmlclj

(section-to-html section)
source

single-page-htmlclj

(single-page-html project-metadata doc all-docs)
source

slurp-resourceclj

(slurp-resource resource-name)

Stolen from leiningen

Stolen from leiningen
sourceraw docstring

toc-htmlclj

(toc-html props docs)
source

uberdoc-htmlclj

(uberdoc-html project-metadata docs)

This generates a stand alone html file (think lein uberjar). It's probably the only var consumers will use.

This generates a stand alone html file (think `lein uberjar`).
It's probably the only var consumers will use.
sourceraw docstring

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

× close