Configuration

Settings

Set the desired environment variables so the package knows your image model, controller(s), etc.

Example environment config:

DOC_WEAVER_ROUTE_PREFIX=docs
DOC_WEAVER_DIR=resources/docs

These variables, and more are explained within the config file.

Documentation Directory

The documentation directory is the place where you put your project documentation directories. It may be changed with the config key doc-weaver.storage.dir or the environment variable DOC_WEAVER_DIR. The default documentation directory is resources/docs.

Directory Structure

Each project directory should contain seperate folders for each documented version. Each version must have at least two (2) markdown files, namely documentation.md and installation.md, which serve as the sidebar and initial documentation pages respectively.

[doc dir]
    │
    └─── Project One
    │       └── 1.0
    │       └── 2.1
    │            └── documentation.md     # sidebar nav
    │            └── installation.md      # initial page
    │
    └─── Project Two

Have a project or a great idea? Get in touch!