draftmk 0.4.0

Command-line tool for managing DraftMk documentation environments using Docker and MkDocs.

draftmk

draftmk is a command-line tool that helps developers preview and manage DraftMk-based documentation environments locally using Docker and MkDocs.

It streamlines environment setup, port configuration, container orchestration, and browser preview, all with minimal configuration.

Installation

Install from PyPI:

pip install draftmk

Or add it to your Python project with Poetry:

poetry add draftmk

Commands

draftmk [command] [--options]

init

Initializes the environment:

• Creates required .draftmk directories
• Generates a .env file with non-conflicting ports
• Downloads a default docker-compose.yml from GitHub Gist

draftmk init

up

Runs init if needed, then launches the preview stack and opens the browser.

draftmk up

preview

Starts the DraftMk Docker services and streams logs to the terminal.

draftmk preview --open

• --open: Opens the frontend in the default browser

view

Opens the frontend in the default browser (reads the port from .env).

draftmk view

logs

Displays the last 50 lines from the .draftmk/logs/draftmk.log file.

draftmk logs

stop

Stops all running DraftMk Docker containers.

draftmk stop

status

Displays the status of all services managed by DraftMk.

draftmk status

Requirements

• Python 3.6 or higher
• Docker
• Docker Compose

Directory Structure

After initialization, the project structure will look like this:

.draftmk/
├── config/
├── site/
│   ├── public/
│   └── internal/
├── logs/
.env
docker-compose.yml

License

MIT © Jonmatum

---

echo "Pura Vida & Happy Coding!";