Metadata-Version: 2.1
Name: jinjabread
Version: 0.4.0
Summary: An Python-based static site generator using Jinja templates.
License: MIT License
        
        Copyright (c) 2024 Jason Wallace
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Repository, https://github.com/jdeanwallace/jinjabread.git
Project-URL: Bug Tracker, https://github.com/jdeanwallace/jinjabread/issues
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: jinja2 ==3.1.3
Requires-Dist: markdown ==3.6
Requires-Dist: markdown-full-yaml-metadata ==2.2.1
Requires-Dist: beautifulsoup4 ==4.12.3
Requires-Dist: werkzeug[watchdog] ==3.0.1

# jinjabread

**WORK IN PROGRESS**

An Python-based static site generator using Jinja templates.

Inspired by [`staticjinja`](https://github.com/staticjinja/staticjinja) and [`hugo`](https://github.com/gohugoio/hugo).

## Install

```bash
pip install jinjabread
```

## Usage

### Create new jinjabread site

```bash
python -m jinjabread new mysite
cd mysite
```

### Build jinjabread site

```bash
python -m jinjabread build .
```

### Run development server

```bash
python -m jinjabread serve .
```

## Contributing

### Setup

```bash
python -m venv venv && \
  . venv/bin/activate && \
  pip install pip pip-tools --upgrade && \
  pip-sync requirements.txt
```

### Test

```bash
python -m unittest jinjabread.tests
```

### Build

```bash
rm -r build dist
python -m build
```

### Release

```bash
python -m twine upload dist/*
```
