Configuration

• Settings
• Documentation Directory
• Directory Structure
• Meta file

Settings

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

Example environment config:

DOCWEAVER_ROUTE_PREFIX=docs
DOCWEAVER_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 docweaver.storage.dir or the environment variable DOCWEAVER_DIR. The default documentation directory is resources/docs.

Directory Structure

Each project directory should contain separate 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
    │            └── .docweaver.yml       # meta file (optional)
    │            └── documentation.md     # sidebar nav
    │            └── installation.md      # initial page
    │
    └─── Project Two

Meta File

Configurations for each doc version may be placed in .docweaver.yml. The supported settings are:

• name

  Product name.

• description

  Product description.

• image_url

  Product image url. This may be an absolute url (e.g. http://mywebsite.com/myimage.jpg) or an image found in the images resource directory.

  To use the foo.jpg in the images directory you would set image_url to /reliqarts/docs/Docweaver/main/images/foo.jpg.

  For more info. see: Assets