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:

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 and is meant to be generated by mkpages itself:

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:

pip install -e '.[dev]'

Available linting tools:

  • black
  • isort
  • flake8

Project links

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (0.4.1)

1 maintainer

PyPI data
Data sourced directly from PyPI's database.
Avatar for rsgalloway from gravatar.com rsgalloway

Credits

Author: Ryan Galloway

License

BSD License (BSD-3-Clause)

Requires

Python >=3.8

Provides Extra

dev test

Tags

markdown jekyll static-site github-pages cli

Classifiers

Report project as malware

Download files

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

Source Distribution

mkpages-0.2.3.tar.gz (32.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mkpages-0.2.3-py3-none-any.whl (36.4 kB view details)

Uploaded Python 3

File details

Details for the file mkpages-0.2.3.tar.gz.

File metadata

  • Download URL: mkpages-0.2.3.tar.gz
  • Upload date:
  • Size: 32.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for mkpages-0.2.3.tar.gz
Algorithm Hash digest
SHA256 43aa83fd9f9856af7965a04bc7c9ee6f6ae9116344c88824f40e60b70a81aa95
MD5 c20a6bc825d8ef4939a618fbc78ff828
BLAKE2b-256 f95dd6c1c0f81ef85635ade84510e57258aab04961ba236b477c4438ddf86b70

See more details on using hashes here.

File details

Details for the file mkpages-0.2.3-py3-none-any.whl.

File metadata

  • Download URL: mkpages-0.2.3-py3-none-any.whl
  • Upload date:
  • Size: 36.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.8.10

File hashes

Hashes for mkpages-0.2.3-py3-none-any.whl
Algorithm Hash digest
SHA256 65b05d974286857ed2b8879f444642c0f1ae247f9308df041303417729604094
MD5 3c14486145611371773429c78edd975b
BLAKE2b-256 bb5b2629b5748acfac8051f934cea6ec2770274e1bf3233c61cb9b0f05f88998

See more details on using hashes here.

Release history Release notifications | RSS feed

0.4.1

2 files

0.4.0

2 files

0.3.1

2 files

0.3.0

2 files

This release

0.2.3 This release

2 files

0.2.2

2 files

0.2.1

2 files

0.2.0

2 files

0.1.0

2 files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page