Skip to main content

A static site generator made for MarkDown, HTML, JsonSchema, XMLSchema, and more

Project description

Menagerie

A static site generator that supports:

  • Markdown
  • HTML
  • JSON Schemas
  • XML Schemas
  • YAML Schemas

Setup

Install the package via your favorite virtual environment manager:

pipenv install menagerie-docs

Run the start_project command

python -m menagerie start_project MySite

This will create a content/ folder as well as a config.json within a folder called MySite.

Also, you may want to add ./m_cache to your .gitignore

Building

To generate the site, run the following:

python -m menagerie generate

This will output to a folder named out/; to view the site open the generated index.html in your browser.

Custom Config Path

python -m menagerie generate --config=PATH/TO/CONFIG

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

menagerie-docs-0.0.4.tar.gz (38.1 kB view hashes)

Uploaded Source

Built Distribution

menagerie_docs-0.0.4-py3-none-any.whl (54.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page