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 details)

Uploaded Source

File details

Details for the file Markdown-Editor-1.0.7.tar.gz.

File metadata

  • Download URL: Markdown-Editor-1.0.7.tar.gz
  • Upload date:
  • Size: 549.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.7.1 importlib_metadata/4.8.1 pkginfo/1.8.2 requests/2.26.0 requests-toolbelt/0.9.1 tqdm/4.62.3 CPython/3.10.1

File hashes

Hashes for Markdown-Editor-1.0.7.tar.gz
Algorithm Hash digest
SHA256 25161686b18889249847570727a69e9cba8383754f279f4baaf4113deb3fbe52
MD5 d3a5d9310904981034fa949fa876150b
BLAKE2b-256 4d9d3d5eb9c7c6488cdf9e072d7beecf4411cb1882fb0010ad34801218b7b66e

See more details on using hashes here.

Supported by

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