Skip to main content

Standalone editor for your markdown files

Project description

Build Status PyPI py versions PyPI version

Standalone editor for your local markdown files


To install the latest stable version from Pypi :

$ pip install markdown-editor


$ markdown_edit

It will open the editor in your browser :




  • Side-by-side markdown editor & html preview
  • Live, when you type html preview
  • Codehilite & markdown extra syntax support by default
  • Github syntax support
  • Github styles for rendering and codehilite
  • Scrollbars sync


  • Markdown
  • Pygments
  • Bottle
  • pymdown-extensions

Other usage examples

Launch editor without input file for testing :

$ markdown_edit

Edit markdown file and save both markdown and html outputs :

$ markdown_edit -f README.html


You can import this script as a module to write your own applications based on the markdown editor.

example :

from markdown_editor import web_edit
from markdown_editor.editor import MarkdownDocument

# ...

MY_HTML_HEAD = 'Editor title'

def action_send(document):

    # or
    # or

    return html_to_display_as_result, keep_running_local_server

if __name__ == '__main__:
    doc = MarkdownDocument()
                ('Send', action_send),

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for Markdown-Editor, version 1.0.4
Filename, size File type Python version Upload date Hashes
Filename, size Markdown_Editor-1.0.4-py2.py3-none-any.whl (557.6 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size Markdown-Editor-1.0.4.tar.gz (547.2 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring DigiCert DigiCert EV certificate Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page