Python-Markdown-Editor

Standalone editor for your local markdown files

Installation

To install the latest stable version from Pypi :

$ pip install markdown-editor

Usage

$ markdown_edit README.md

It will open the editor in your browser :

screenshot

Features

• 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

Dependencies

• 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 README.md

Extensible

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

example :

frommarkdown_editorimportweb_editfrommarkdown_editor.editorimportMarkdownDocument# ...MY_HTML_HEAD='Editor title'defaction_send(document):
send_markdown_text(document.text)
# orsend_raw_html_code(document.getHtml())
# orsend_html_with_styles(document.getHtmlPage())
returnhtml_to_display_as_result, keep_running_local_serverif__name__== '__main__:
doc=MarkdownDocument()
web_edit.start(doc,
custom_actions=[
('Send', action_send),
],
title=MY_HTML_HEAD)