Skip to content

Files

Latest commit

 

History

History
 
 

zsdoc

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 

Code documentation

Here is Asciidoc code documentation generated using Zshelldoc. There are 4 Zinit's source files, the main one is zinit.zsh. The documentation lists all functions, interactions between them, their comments and features used.

Github allows to directly view Asciidoc documents:

PDFs, man pages, etc.

Formats other than Asciidoc can be produced by using provided Makefile. For example, issuing make pdf will create and populate a new directory pdf (requires asciidoctor, install with gem install asciidoctor-pdf --pre). make man will create man pages (requires package asciidoc, uses its command a2x, which is quite slow).