markdown-os 0.4.1

Developer-focused markdown editor served from a local CLI.

Markdown-OS

Developer-focused markdown editor that runs as a local web server. Edit in the browser with live preview, Mermaid diagrams, syntax highlighting, and auto-save.

Install

pip install markdown-os

Or with uv:

uv tool install markdown-os

To upgrade after installing with uv: uv tool upgrade markdown-os

Usage

Single file:

markdown-os open ./notes.md

Directory (markdown workspace):

markdown-os open ./my-notes

The app opens in your browser. If port 8000 is in use, the next port is tried. Options: --host, --port.

Example file

Generate a showcase markdown file:

markdown-os example                    # creates example.md in current directory
markdown-os example ./docs/showcase.md # custom path
markdown-os example --open             # generate and open in the editor

Use --force / -f to overwrite an existing file without prompting.

Publishing (maintainers)

1. Bump version in pyproject.toml.
2. Commit and push to master: git add pyproject.toml && git commit -m "chore: release X.Y.Z" && git push origin master
3. Tag that commit and push: git tag -a vX.Y.Z -m "Release X.Y.Z" && git push origin vX.Y.Z

The GitHub workflow runs on tag push and publishes to PyPI only when the tag matches the package version.