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 :

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)

Metadata

Release files for Markdown-Editor 1.0.7

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for Markdown-Editor 1.0.7
File	Size	Uploaded	Provenance
Markdown-Editor-1.0.7.tar.gz	549.1 kB	Jan 24, 2022	Without provenance	Details

Release files / Markdown-Editor-1.0.7.tar.gz

Download URL	Markdown-Editor-1.0.7.tar.gz
Size	549.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`25161686b18889249847570727a69e9cba8383754f279f4baaf4113deb3fbe52`
BLAKE2b-256 checksum How to use checksums	`4d9d3d5eb9c7c6488cdf9e072d7beecf4411cb1882fb0010ad34801218b7b66e`
Upload date	Jan 24, 2022
Uploaded using Trusted Publishing? What is 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`

Security for Markdown-Editor 1.0.7

Report project as malware

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.