Set the desired environment variables so the package knows your image model, controller(s), etc.
Example environment config:
These variables, and more are explained within the config file.
The documentation directory is the place where you put your project documentation directories. It may be changed with the config key
docweaver.storage.dir or the environment variable
DOC_WEAVER_DIR. The default documentation directory is
Each project directory should contain seperate folders for each documented version. Each version must have at least two (2) markdown files, namely
installation.md, which serve as the sidebar and initial documentation pages respectively.
[doc dir] │ └─── Project One │ └── 1.0 │ └── 2.1 │ └── .docweaver.yml # meta file (optional) │ └── documentation.md # sidebar nav │ └── installation.md # initial page │ └─── Project Two
Configurations for each doc version may be placed in
.docweaver.yml. The supported settings are:
Product image url. This may be an absolute url (e.g.
http://mywebsite.com/myimage.jpg) or an image found in the
To use the
foo.jpgin the images directory you would set
For more info. see: Assets