Menagerie Docs

Menagerie docs is a python package used to generate static sites from a menagerie (see what I did there?) of files.

Installation

To get started, install menagerie-docs with your package manager.

pip install menagerie-docs

Starting a Project

Once installed, you can use the new-project command.

menagerie new-project MyCoolDocsSite

This will create a new folder called MyCoolDocsSite with the following contents:

- content/
    - pages/
        - index.md
    - static/
- config.json

Generating the Site

To generate the site, run the generate command.

menagerie generate

You can also specify a different config file by passing it in as an arg.

menagerie generate --config my-config.json

Next Steps

Now you're ready to start creating your site!
For help with this, look at the rest of this site, the pages page is a good place to start.
In addition, this site was generated in menagerie, so you can use it as an example.