Liking cljdoc? Tell your friends :D

readmoi.core

Functions for generating ReadMoi webpages.

File resources/readmoi_options.edn contains a map with the following key-vals.

Required keys:

  • :sections, and within each section:
    • :section-name
    • :section-href
    • :section-skip-load?

Optional keys:

  • :clojars-badge?
  • :copyright-holder
  • :fn-map-additions
  • :license-hiccup
  • :project-description
  • :project-name-formatted
  • :readme-UUID
  • :readme-html-directory
  • :readme-html-filename
  • :readme-markdown-directory
  • :readme-markdown-filename
  • :sections-directory
  • :separator
  • :wrap-at

See project's documentation for details.

Functions for generating ReadMoi webpages.

File `resources/readmoi_options.edn` contains a map with the following
key-vals.

Required keys:

* `:sections`, and within each section:
    - `:section-name`
    - `:section-href`
    - `:section-skip-load?`

Optional keys:

* `:clojars-badge?`
* `:copyright-holder`
* `:fn-map-additions`
* `:license-hiccup`
* `:project-description`
* `:project-name-formatted`
* `:readme-UUID`
* `:readme-html-directory`
* `:readme-html-filename`
* `:readme-markdown-directory`
* `:readme-markdown-filename`
* `:sections-directory`
* `:separator`
* `:wrap-at`

See [project's documentation](https://github.com/blosavio/readmoi) for
details.
raw docstring

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

× close