mdedit
A terminal Markdown viewer and editor, built with Textual and Rich.
Open a .md file to a fully rendered view (headings, tables, code blocks,
lists, block quotes...) and press a single key to toggle into a
syntax-highlighted source editor for the same file — then toggle back to see
your changes rendered.
Install
pip install git+https://github.com/matplo/mdedit
Usage
mdedit path/to/file.md # open (or create) a file
mdedit # start with a prompt to open/create a file
Key bindings
| Key | Action |
|---|---|
ctrl+t |
Toggle between view and edit mode |
ctrl+s |
Save |
ctrl+r |
Reload from disk |
ctrl+q |
Quit (prompts if unsaved changes) |
Note: if
ctrl+sdoesn't seem to do anything in your terminal, it may be intercepted by terminal flow control (XON/XOFF). Runstty -ixonin your shell first, or use the Save option from the command palette (ctrl+p).
Development
pip install -e ".[dev]"
pytest
ruff check .
ruff format --check .
Releasing to PyPI
Releases publish automatically via GitHub Actions using trusted publishing (no API token stored anywhere). To cut a release:
- Bump
__version__insrc/mdedit/__init__.py, commit it. - Tag and push:
git tag vX.Y.Z && git push origin vX.Y.Z - The
Publish to PyPIworkflow builds the sdist/wheel and uploads them.
Roadmap
v1 is intentionally scoped to a single-file, toggle-based view/edit experience. Not yet included (candidates for a future version):
- Always-rendered, true WYSIWYG editing (edit directly on rendered text, no separate source view)
- Split-pane side-by-side edit + preview
- Browser-style navigation history, bookmarks, remote/URL loading
- Multiple open files / tabs
License
MIT
1 maintainer
Metadata
1 maintainer
Release files for mdedit 0.1.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 | |
|---|---|---|---|---|
| mdedit-0.1.0.tar.gz | 9.5 kB | With provenance | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| mdedit-0.1.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 21.0 kB
Release files / mdedit-0.1.0.tar.gz
| Download URL | mdedit-0.1.0.tar.gz |
|---|---|
| Size | 9.5 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
5903ae8ece703f099cda3469b3d72efb39adf9cce385ca1e101f7d2696f9288c
|
|
BLAKE2b-256 checksum How to use checksums |
28d38510acd9733d52896fbb021bd209ba15d6ae7305e1a9a03ee22601d414dc
|
| 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 Sep 2, 2026.
Transparency logRelease files / mdedit-0.1.0-py3-none-any.whl
| Download URL | mdedit-0.1.0-py3-none-any.whl |
|---|---|
| Size | 11.5 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a73b71c724c33cf865935c03f37849c23413c0df817b7bf7bfc216aa621865df
|
|
BLAKE2b-256 checksum How to use checksums |
a95272076c867783470a8f9833b4e9e310b092cedda10309b8192f80099c2ce2
|
| 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 Sep 2, 2026.
Transparency logSecurity for mdedit 0.1.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 mdedit-0.1.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 Sep 2, 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.
