Skip to main content

Standalone editor for your markdown files

Project description

Build Status PyPI py versions PyPI version Code quality

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
from markdown_editor.editor import MarkdownDocument

# ...

MY_HTML_HEAD = 'Editor title'

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__:
    doc = MarkdownDocument()
    web_edit.start(doc,
        custom_actions=[
                ('Send', action_send),
        ],
        title=MY_HTML_HEAD)

Project details


Download files

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

Source Distribution

Markdown-Editor-1.0.7.tar.gz (549.1 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page