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
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file markdown_os-1.3.0.tar.gz.
File metadata
- Download URL: markdown_os-1.3.0.tar.gz
- Upload date:
- Size: 15.7 MB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
d196476881df7b396b9b98d8fcb4e4840b1ebe88b2cff31ddddb2b71aea644f1
|
|
| MD5 |
86e73d162ae8e04b4e3e3606ccd5b101
|
|
| BLAKE2b-256 |
1207995530e4eb22dd76e2358767566ed7ab2d696d4fdfcc7da44433ee632641
|
Provenance
The following attestation bundles were made for markdown_os-1.3.0.tar.gz:
Publisher:
publish.yml on elena-cabrera/markdown-os
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
markdown_os-1.3.0.tar.gz -
Subject digest:
d196476881df7b396b9b98d8fcb4e4840b1ebe88b2cff31ddddb2b71aea644f1 - Sigstore transparency entry: 2615704948
- Sigstore integration time:
-
Permalink:
elena-cabrera/markdown-os@6d0c686d73395feb9a67198f6834b206203fea18 -
Branch / Tag:
refs/tags/v1.3.0 - Owner: https://github.com/elena-cabrera
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6d0c686d73395feb9a67198f6834b206203fea18 -
Trigger Event:
push
-
Statement type:
File details
Details for the file markdown_os-1.3.0-py3-none-any.whl.
File metadata
- Download URL: markdown_os-1.3.0-py3-none-any.whl
- Upload date:
- Size: 2.5 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
86bbeb6f4d4de4c03c0419d86be5baac03fe01e07f3ff140a6b811d14edb0178
|
|
| MD5 |
eda9383dec188e9db1374c615013be94
|
|
| BLAKE2b-256 |
3bd10d024d282bd2f8088bdedfb6e92356e5d15996c2558b3b713ea849db8814
|
Provenance
The following attestation bundles were made for markdown_os-1.3.0-py3-none-any.whl:
Publisher:
publish.yml on elena-cabrera/markdown-os
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
markdown_os-1.3.0-py3-none-any.whl -
Subject digest:
86bbeb6f4d4de4c03c0419d86be5baac03fe01e07f3ff140a6b811d14edb0178 - Sigstore transparency entry: 2615705049
- Sigstore integration time:
-
Permalink:
elena-cabrera/markdown-os@6d0c686d73395feb9a67198f6834b206203fea18 -
Branch / Tag:
refs/tags/v1.3.0 - Owner: https://github.com/elena-cabrera
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
publish.yml@6d0c686d73395feb9a67198f6834b206203fea18 -
Trigger Event:
push
-
Statement type:
