Liking cljdoc? Tell your friends :D

documents

:documents key in build.edn file shoud be a sequence of the following map.

nametyperequired?description

file

string?

Yes

Document file path to update

match

string?

Yes for actions excepting create

Regexp for matching base line in the :file

match-exactly

string?

Can be used as an alternative to match.

Plain string for matching base line in the :file

action

:append-before, :replace, :append-after or :create

Yes

Action type.

  • append-before — Append :text before the base line

  • replace — Replace the base line by :text

  • append-after — Append :text after the base line

  • create — Create a new file which has :text as contents

keep-indent?

boolean?

No, but only available for actions excepting create

If true, the text to be updated will keep the indentation of the text matched to match

text

string?

Yes

Text handled by :action

Can you improve this documentation? These fine people already did:
liquidz & Ivar Refsdal
Edit on GitHub

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

× close