Liking cljdoc? Tell your friends :D

chlog.core

Changelog aggregation, specification, validation, and webpage generation.

Options map key-vals:

  • :project-formatted-filename
  • :copyright-holder
  • :changelog-UUID
  • :changelog-html-directory
  • :changelog-html-filename
  • :changelog-markdown-directory
  • :changelog-markdown-filename
  • :changelog-entries-directory
  • :changelog-policies-section (optional)
Changelog aggregation, specification, validation, and webpage generation.

Options map key-vals:

* `:project-formatted-filename`
* `:copyright-holder`
* `:changelog-UUID`
* `:changelog-html-directory`
* `:changelog-html-filename`
* `:changelog-markdown-directory`
* `:changelog-markdown-filename`
* `:changelog-entries-directory`
* `:changelog-policies-section` (optional)
raw docstring

chlog-defaultsclj

A hash-map residing in chlog_defaults.clj that supplies the default values for the following options keys:

  • :changelog-html-directory
  • :changelog-html-filename
  • :changelog-markdown-directory
  • :changelog-markdown-filename
  • :changelog-entries-directory
  • :changelog-data-file
  • :changelog-policies-section
  • :tidy-html?

Override default values by associating new values into the Chlog options hash-map. See generate-all-changelogs.

A hash-map residing in `chlog_defaults.clj` that supplies the default values
for the following options keys:

* `:changelog-html-directory`
* `:changelog-html-filename`
* `:changelog-markdown-directory`
* `:changelog-markdown-filename`
* `:changelog-entries-directory`
* `:changelog-data-file`
* `:changelog-policies-section`
* `:tidy-html?`

Override default values by associating new values into the Chlog _options_
hash-map. See [[generate-all-changelogs]].
sourceraw docstring

generate-all-changelogsclj

(generate-all-changelogs opt)

Given Chlog options opt, write-to-file html and markdown changeloges.

See project documentation for details on the structure of the options map.

Changelog data will be read from resources/changelog_entries/changelog.edn unless superseded by :changelog-entries-directory or :changelog-data-file values in the options map.

Defaults supplied by src/chlog_defaults.edn

Given Chlog options `opt`, write-to-file html and markdown changeloges.

See project documentation for details on the structure of the options map.

Changelog data will be read from `resources/changelog_entries/changelog.edn`
unless superseded by `:changelog-entries-directory` or
`:changelog-data-file` values in the options map.

Defaults supplied by `src/chlog_defaults.edn`
sourceraw docstring

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

× close