This is the litterae Reference Manual, version 0.3.0, generated automatically by Declt version 4.0 beta 2 "William Riker" on Mon Feb 26 17:10:27 2024 GMT+0.
The main system appears first, followed by any subsystem dependency.
litteraeBeautiful documentation generation.
Stefan Devai <stedevai@gmail.com>
MIT
0.3.0
docparser (system).
lsx (system).
3bmd (system).
3bmd-ext-code-blocks (system).
str (system).
cl-yaml (system).
source (module).
Modules are listed depth-first from the system components tree.
litterae/sourcelitterae (system).
package.lisp (file).
config.lisp (file).
templates/index.lisp (file).
litterae.lisp (file).
Files are sorted by type and then listed depth-first from the systems components trees.
litterae/litterae.asdlitterae/source/package.lisplitterae/source/config.lisplitterae/source/templates/index.lisplitterae/source/litterae.lisplitterae/source/config.lisppackage.lisp (file).
source (module).
*asdf-system* (special variable).
*config-filename* (special variable).
*docstrings-as-markdown?* (special variable).
*index* (special variable).
*symbols* (special variable).
*system-name* (special variable).
load-config (function).
search-and-load-config-file (function).
set-config (function).
set-single-config (macro).
litterae/source/templates/index.lispconfig.lisp (file).
source (module).
has-attr? (function).
index-template (class).
litterae/source/litterae.lisptemplates/index.lisp (file).
source (module).
build-symbols-hash (function).
do-node-lists (macro).
do-package-hashes (macro).
format-lambda-list (function).
format-lambda-list-html (function).
gen-html-node-item (function).
generate-html (function).
generate-html-index (function).
generate-html-index-body (function).
generate-id (function).
generate-list (function).
get-lambda-list (function).
get-node-type-string (function).
html-api-docs (function).
html-hero (function).
html-readme (function).
html-sidebar (function).
initialize-system-information (function).
make-index-template (function).
parse-markdown-docstring (function).
read-markdown (function).
Packages are listed by definition order.
litteraecommon-lisp.
lsx.
*asdf-system* (special variable).
*config-filename* (special variable).
*docstrings-as-markdown?* (special variable).
*index* (special variable).
*symbols* (special variable).
*system-name* (special variable).
build-symbols-hash (function).
do-node-lists (macro).
do-package-hashes (macro).
format-lambda-list (function).
format-lambda-list-html (function).
gen-html-node-item (function).
generate-html (function).
generate-html-index (function).
generate-html-index-body (function).
generate-id (function).
generate-list (function).
get-lambda-list (function).
get-node-type-string (function).
has-attr? (function).
html-api-docs (function).
html-hero (function).
html-readme (function).
html-sidebar (function).
index-template (class).
initialize-system-information (function).
load-config (function).
make-index-template (function).
parse-markdown-docstring (function).
read-markdown (function).
search-and-load-config-file (function).
set-config (function).
set-single-config (macro).
Definitions are sorted by export status, category, package, and then by lexicographic order.
Hold’s the system’s asdf information.
Holds the default config filename.
If true, docstrings will be parsed as markdown, otherwise it uses the string as it is.
Holds raw information about a system provided by docparser library.
Structured information about the system’s symbols.
Holds system’s name as symbol.
Iterates through lists of nodes in a ‘package-hash’ contained in ‘*index’.
Iterates through the package hashes in ‘*index*’
Sets the value of **parameter** to the value of **keyword** in **hash-table** only if the keyword exists.
Stores in ‘*symbols*’ a hash of hashes of lists: a hash of package names, which each value contains a hash of class names which, each value contains a list of node names.
Formats a lambda list ‘lst‘ and returns it as a string.
Returns a lambda list string with proper formated HTML.
Returns each docparser node formated as HTML.
Generates HTML for the contents of a parsed system in ‘*symbols*’.
Generates index.html in ‘path’.
Generates the body content for the index page.
Generates an id string for html given an element in the format ‘(list :id 0 :name some-name)‘.
Generates a list with ‘elements’. If ‘child-list?’ is true, it uses the first element
of ‘elements’ (car) as the title and the other elements as lines of a new list. If child-list?
is false, then each element in ‘elements’ will be a list.
element-format allows to customize how the element will be printed.
If the node is of type operator-node, the function returns its lambda list. Otherwise it returns the node-name as a string.
Return a string of ‘node-type’ for headers. If ‘plural’ is non nil, it returns its plural version.
Return true if the attribute ‘attr’ holds a value, false otherwise.
Returns the main API documentation content as a lsx object.
Generates the Hero HTML.
Searches for a README file in the system’s directory and returns it as a HTML string.
Returns the sidebar used to navigate through the API.
Loads config contained in **filepath**. If it’s nil, searches for a default config file to load.
Creates a object instance for ‘index-template’.
Returns a **docstring** in markdown format as a HTML string.
Reads and parses a markdown file located in ‘filepath’.
If a default config file exists, return its contents. Otherwise returns nil.
Sets configs parameters from **config**, a parsed yaml file. Always returns t to indicate that a new config was set.
| Jump to: | B D F G H I L M P R S |
|---|
| Jump to: | B D F G H I L M P R S |
|---|
| Jump to: | *
B D L S T U |
|---|
| Jump to: | *
B D L S T U |
|---|
| Jump to: | C F I L M P S T |
|---|
| Jump to: | C F I L M P S T |
|---|