marginalia.html — com.github.tsmacdonald/marginalia 0.9.2

Utilities for converting parse results into html.

*resources* clj

codes-to-html clj

(codes-to-html code-block)

css clj

(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;}

css-rule clj

(css-rule rule)

dependencies-html clj

(dependencies-html deps & header-name)

docs-to-html clj

(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 />"

floating-toc-css clj

floating-toc-html clj

(floating-toc-html docs)

general-css clj

groups-html clj

(groups-html props doc)

header-css clj

header-html clj

(header-html project-info)

index-html clj

(index-html project-metadata docs)

inline-css clj

(inline-css resource)

inline-js clj

(inline-js resource)

link-to-namespace clj

(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.

link-to-toc clj

(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.

md clj

(md s)

Markdown string to html converter. Translates strings like:

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

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

...

mdp clj

opt-resources-html clj

(opt-resources-html project-info)

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

page-template clj

(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.

reset-css clj

section-to-html clj

(section-to-html section)

single-page-html clj

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

slurp-resource clj

(slurp-resource resource-name)

Stolen from leiningen

toc-html clj

(toc-html props docs)

uberdoc-html clj

(uberdoc-html project-metadata docs)

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