Skip to content
Simple modular documentation builder for with package reference generator
Common Lisp
Find file
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
doc
README.md
cl-gendoc.asd
gendoc.lisp
package.lisp

README.md

cl-gendoc

This is a simple but flexible modular document generator for Common Lisp, because I couldn't find something similar:

(gendoc (:output-filename "docs.html"
         :css "simple.css")
  (:mdf "intro.md")
  (:mdf "details.md")
  (:apiref :some-package :another-package)
  (:mdf "closing.md"))

Of some interest is probably the API reference generator:

(defun some-function (X)
  "=> output-forms

This takes `X` and produces *output-forms*"
  ...)

The docstring is processed as markdown with 3bmd, optionally specifying a return-spec if the first line starts with "=>".

See the generated documentation for cl-gendoc.

Something went wrong with that request. Please try again.