Doc

List of symbols:

build-doc, doc-map, doc-search, get-exemptions, get-globals-sorted, legacy-report, legacy_forms

build-doc

Usage: (build-doc valid-filepath)

Namespace: root

Uses mdbook to build the documentation for the given book.

Example:

#t

doc-map

Usage: (doc-map symbol)

Namespace: root

Returns documentation for given symbol as map. Keyword is a documentation fragment (usage, section, description, example) and value is text describing given fragment.

Example:

#t

doc-search

Usage: (doc-search query-string [options-map])

Namespace: root

Search through all documentation for functions matching the query. The query string is searched across all documentation fields by default.

Options map can contain:

:regex #t - Use regular expressions for matching
:basic #t - Use basic matching (characters must appear in order)
:fields ["usage" "description"] - Limit search to specific fields
:namespace "namespace-name" - Filter by namespace
:section "section-name" - Filter by section
:markdown #t - Return results as a markdown-formatted string instead of vector
:styled #t - Return results with highlighted search matches
:style {:highlight-color "\x1b[43m\x1b[30m" ...} - Customize highlight style

Style options (when :style map is provided):

:highlight-color - Color for highlighting matches (default: yellow background, black text)
:default-color - Color to reset after highlight (default: \x1b[0m)
:use-background #f - Use foreground color instead of background

When :styled is true, matching text in results is highlighted to show why each result matched the search query.

Returns a vector of documentation maps, markdown string, or styled string.

Example:

(doc-search "file")
(doc-search "^str-" {:regex #t})
(doc-search "core" {:fields ["section"]})
(doc-search "map" {:basic #t :section "core"})
(doc-search "string" {:markdown #t})
(doc-search "string" {:styled #t})
(doc-search "map" {:style {:highlight-color *fg-red* :use-background #f}})