Metadata-Version: 2.1
Name: mkpages
Version: 0.2.1
Summary: Generate Jekyll source trees from Markdown folder structures.
Author-email: Ryan Galloway <ryan@rsgalloway.com>
License: BSD-3-Clause
Project-URL: Homepage, https://github.com/rsgalloway/mkpages
Project-URL: Repository, https://github.com/rsgalloway/mkpages
Project-URL: Issues, https://github.com/rsgalloway/mkpages/issues
Keywords: markdown,jekyll,static-site,github-pages,cli
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Internet :: WWW/HTTP :: Site Management
Classifier: Topic :: Software Development :: Build Tools
Classifier: Topic :: Text Processing :: Markup
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: importlib_resources>=5.10; python_version < "3.9"
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: flake8==7.1.1; extra == "dev"
Requires-Dist: mccabe==0.7.0; extra == "dev"
Requires-Dist: isort==5.13.2; extra == "dev"
Requires-Dist: black==24.8.0; extra == "dev"
Provides-Extra: test
Requires-Dist: pytest; extra == "test"

# mkpages

`mkpages` is a Python CLI for generating Jekyll source trees from an existing
Markdown folder tree.

The long-term goal is a package you can install with:

```bash
pip install mkpages
```

and then use to build GitHub Pages-friendly static sites from project
documentation such as `docs/`.

## Documentation

Project documentation lives in [docs/index.md](docs/index.md) and is meant to
be generated by `mkpages` itself:

```bash
mkpages build docs/
```

## Project Layout

- `bin/` contains small distributable CLI shims.
- `src/` contains the Python package.
- `tmp/` is scratch space for planning and experiments.

## Development

Install the project in editable mode with development tools:

```bash
pip install -e '.[dev]'
```

Available linting tools:

- `black`
- `isort`
- `flake8`
