Getting Started

Install

Install mkpages from PyPI:

pip install mkpages

For local development in this repository:

pip install -e '.[dev]'

Basic usage

Generate a Jekyll source tree from the current directory:

mkpages build

Generate from a docs/ folder into .mkpages/:

mkpages build docs/

What gets generated

The output directory contains:

• _config.yml
• _layouts/default.html
• _includes/
• generated Markdown pages with front matter
• copied non-Markdown assets
• assets/site.css
• .mkpages-output

Next steps

Once the output exists, point a Jekyll build at it. See GitHub Pages for a typical workflow.

For local preview with Jekyll installed:

mkpages build docs/
mkpages serve

mkpages serve uses the existing .mkpages output and opens the preview URL in your default browser when possible.