Skip to main content
Help us improve PyPI by participating in user testing. All experience levels needed!

Standalone editor for your markdown files

Project description

Build Status PyPI py versions PyPI version

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

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 :

from markdown_editor import web_edit

# ...

def action_send(document):

    send_markdown_text(document.text)
    # or
    send_raw_html_code(document.getHtml())
    # or
    send_html_with_styles(document.getHtmlPage())

    return html_to_display_as_result, keep_running_local_server

if __name__ == '__main__:
    web_edit.start(
        actions =
            [
                ('Send', action_send),
            ],
        title = MY_HTML_HEAD)

Project details


Release history Release notifications

This version
History Node

1.0.3

History Node

1.0.2

History Node

1.0.1

History Node

1.0.0

History Node

0.9.9

History Node

0.9.8

History Node

0.9.7

History Node

0.9.6

History Node

0.9.5

History Node

0.9.4

History Node

0.9.3

History Node

0.9.2

History Node

0.9.1

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
Markdown_Editor-1.0.3-py2.py3-none-any.whl (559.3 kB) Copy SHA256 hash SHA256 Wheel py2.py3 Feb 24, 2017
Markdown-Editor-1.0.3.tar.gz (546.4 kB) Copy SHA256 hash SHA256 Source None Feb 24, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page