diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/tissue.skb | 7 |
1 files changed, 7 insertions, 0 deletions
diff --git a/doc/tissue.skb b/doc/tissue.skb index 41159ae..3c46c39 100644 --- a/doc/tissue.skb +++ b/doc/tissue.skb @@ -21,6 +21,7 @@ (document :title [tissue] (toc) (chapter :title [Introduction] + :ident "chapter-introduction" (p [tissue is an issue tracker and project information management system built on plain text files and git. It is specifically intended for small free software projects. It features a static site generator @@ -30,6 +31,7 @@ built on the ,(ref :url "https://xapian.org/" :text "Xapian search engine library"), and is available both as a command-line program and as a web server.])) (chapter :title [Gemtext markup for issues] + :ident "chapter-gemtext-markup" (p [Issues must be written in ,(ref :url "https://gemini.circumlunar.space/docs/gemtext.gmi" :text "gemtext markup") with added extra notation to specify issue @@ -55,7 +57,9 @@ metadata.]) * \[ \] Then, do this. * \[ \] Finally, do this.]))) (chapter :title [Reference] + :ident "chapter-reference" (section :title [Object and record constructors] + :ident "section-constructors" (description (docstring-function-documentation "tissue/tissue.scm" 'tissue-configuration) (function-documentation 'file [filename writer] @@ -69,6 +73,7 @@ output file to be created.] argument and writes data destined for ,(var [filename]) into that port]))))) (section :title [Reader functions] + :ident "section-reader-functions" (p [These functions produce ,(code [<document>]) objects (or objects of classes inheriting from ,(code [<document>])) by reading files or other data sources.]) @@ -77,6 +82,7 @@ files or other data sources.]) (docstring-function-documentation "tissue/file-document.scm" 'read-gemtext-document) (docstring-function-documentation "tissue/commit.scm" 'commits-in-current-repository))) (section :title [Writer functions] + :ident "section-writer-functions" [These functions write output files and are meant to be specified in a ,(code [<file>]) object.] (description @@ -84,6 +90,7 @@ specified in a ,(code [<file>]) object.] (docstring-function-documentation "tissue/web/static.scm" 'gemtext-exporter) (docstring-function-documentation "tissue/web/static.scm" 'skribe-exporter))) (section :title [Utility functions] + :ident "section-utility-functions" [These miscellaneous functions are useful when writing tissue configuration files.] (description |