Skip to content

README.md

Latest commit

 

History

History
52 lines (37 loc) · 1.11 KB

README.md

File metadata and controls

52 lines (37 loc) · 1.11 KB

mkdocs-blog

Blog using mkdocs

Dependencies:

  • pip install mkdocs
  • pip install mkdocs-material

How to run

Local

mkdocs serve --livereload

Container (Podman) — any machine, no local Python needed

The repo includes a Containerfile and a run.sh that work on both Fedora and macOS.

SSH agent forwarding is used so your private key never enters the container or the image.

1. Clone the repo

git clone git@github.com:you/notes.git
cd notes

2. Build the image (once per machine)

podman build -t mkdocs .

3. Load your SSH key on the host

ssh-add ~/.ssh/$publicsshkey

4. Run

./run.sh

MkDocs will be available at http://localhost:8000. Files are served from the host directory — edits are reflected live. Git commands (add, commit, push) work inside the container using your host SSH agent.

macOS only: make sure Podman Machine is running before step 4.

podman machine start

References: