Metadata-Version: 2.1
Name: menagerie-docs
Version: 0.0.2
Summary: A static site generator made for MarkDown, HTML, JsonSchema, XMLSchema, and more
Home-page: https://github.com/Bwc9876/menagerie
Author: bwc9876
Author-email: bwc9876@gmail.com
License: GNU Lesser General Public License v2.1
Platform: UNKNOWN
Classifier: License :: OSI Approved :: GNU Lesser General Public License v2 or later (LGPLv2+)
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: Environment :: Console
Classifier: Programming Language :: Python :: 3.10
Classifier: Natural Language :: English
Description-Content-Type: text/markdown
License-File: LICENSE

# 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:

```shell
pipenv install menagerie-docs
```

Run the `start_project` command

```shell
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:

```shell
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

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


