Table of Contents

About

This system adds support for Markdown syntax in both documents and docstrings. When this system is loaded, Staple will automatically scan for documents with the ending md to use as primary documents on inferred pages. It also adds the source-compiler :markdown that can be used to markup documentation source.

To use Markdown for docstrings as well, use a customisation like this on your page type:

(defmethod staple:format-documentation ((docstring string) (page my-page))
  (let ((*package* (first (staple:packages page))))
    (staple:markup-code-snippets-ignoring-errors
     (staple:compile-source docstring :markdown))))

System Information

Definition Index

• COMPRESSION-CACHE

  No documentation provided.

  • EXTERNAL FUNCTION

    ENSURE-PATH-TO-COMPRESSED-FILE

    • FILEPATH
    • &OPTIONAL
    • &KEY
    • ALGORITHM

    Source

    Will check if there is a path for a compressed version of the original pathname and return it, if there is none, it will then compress a file and save it and return the compressed file's path.

  • EXTERNAL FUNCTION

    INITIALIZE-CACHE

    • CACHE-PATH
    • &OPTIONAL
    • ROOT

    Source

    cache-path can be either a pathname or a string of a path to a directory. If the directory doesn't exist it will be created. If a relative directory is provided AKA one not starting with a forward slash '/', the pathname will be derived from the current working directory `(uiop:getcwd)`