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.
Desktop installers for macOS and Windows are published from GitHub Releases. The desktop app bundles the local server and opens with a picker-first workflow, so users do not need Python or a terminal after installation.
Install
pip install markdown-os
Or with uv:
uv tool install markdown-os
To upgrade after installing with uv: uv tool upgrade markdown-os
Desktop app
Download the latest desktop installers from GitHub Releases:
- macOS:
.dmg - Windows:
.exe
The desktop app keeps the same editor UI, but launches in a native desktop shell with recent files/folders and native open dialogs.
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)
Use the release helper from a clean working tree on the branch you want to publish (usually master):
uv run python scripts/release.py
It reads [project].version from pyproject.toml, asks whether to bump major, minor, or patch, updates the file, then runs git add / git commit (only pyproject.toml) / git push -u origin <current-branch> / annotated git tag / git push origin <tag>.
Useful options:
--dry-run— print the planned version and git steps without changing files or running git.-y/--yes— skip the final confirmation prompt.--version X.Y.Z— set an exact version string and skip the bump menu.--branch master— push a specific branch (defaults to your current branch).--repo /path/to/checkout— run against another clone.--allow-dirty— proceed when other files are modified (still only commitspyproject.toml).
Manual sequence (equivalent when you are on master):
- Bump
versioninpyproject.toml. - Commit and push:
git add pyproject.toml && git commit -m "chore: release X.Y.Z" && git push origin master - Tag 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.
1 maintainer
Metadata
1 maintainer
Release files for markdown-os 1.3.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| markdown_os-1.3.0.tar.gz | 15.7 MB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| markdown_os-1.3.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 18.2 MB
Release files / markdown_os-1.3.0.tar.gz
| Download URL | markdown_os-1.3.0.tar.gz |
|---|---|
| Size | 15.7 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
d196476881df7b396b9b98d8fcb4e4840b1ebe88b2cff31ddddb2b71aea644f1
|
|
BLAKE2b-256 checksum How to use checksums |
1207995530e4eb22dd76e2358767566ed7ab2d696d4fdfcc7da44433ee632641
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency logRelease files / markdown_os-1.3.0-py3-none-any.whl
| Download URL | markdown_os-1.3.0-py3-none-any.whl |
|---|---|
| Size | 2.5 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
86bbeb6f4d4de4c03c0419d86be5baac03fe01e07f3ff140a6b811d14edb0178
|
|
BLAKE2b-256 checksum How to use checksums |
3bd10d024d282bd2f8088bdedfb6e92356e5d15996c2558b3b713ea849db8814
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency logSecurity for markdown-os 1.3.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
All 2 files in this release have been uploaded with provenance metadata.
Attestation for markdown_os-1.3.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Aug 27, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
