Liking cljdoc? Tell your friends :D

com.blockether.spel.gen-docs

Generates API reference markdown from source code introspection.

Three categories of API docs:

  1. Library API — public vars from all spel namespaces
  2. SCI eval API — functions available in spel --eval mode
  3. CLI commands — commands available via the spel binary

Usage: clojure -T:build gen-docs make gen-docs

Generates API reference markdown from source code introspection.

Three categories of API docs:
1. Library API — public vars from all spel namespaces
2. SCI eval API — functions available in `spel --eval` mode
3. CLI commands — commands available via the `spel` binary

Usage:
  clojure -T:build gen-docs
  make gen-docs
raw docstring

-mainclj

(-main & _args)

CLI entry point.

CLI entry point.
sourceraw docstring

generate-cli-commandsclj

(generate-cli-commands)

Generates markdown for CLI command tables.

Generates markdown for CLI command tables.
sourceraw docstring

generate-library-apiclj

(generate-library-api)

Generates markdown for all library namespace API tables.

Generates markdown for all library namespace API tables.
sourceraw docstring

generate-sci-apiclj

(generate-sci-api)

Generates markdown for SCI eval API tables.

Generates markdown for SCI eval API tables.
sourceraw docstring

generate-skill-mdclj

(generate-skill-md)

Reads the SKILL.md.template, replaces {{library-api}}, {{sci-api}}, and {{cli-commands}} placeholders with generated content, writes to SKILL.md.

Reads the SKILL.md.template, replaces {{library-api}}, {{sci-api}},
and {{cli-commands}} placeholders with generated content, writes to SKILL.md.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close