A standalone and embeddable Python based Markdown editor with HTML preview.
Explore the docs »
PyPi
·
Report Bug
·
Request Feature
Table of Contents
A standalone and embeddable Python based Markdown editor with HTML preview.
To get a local copy up and running choose one of the below install instructions and follow the steps provided.
The simplest way to install the PyMD Editor is to use pip
:
pip install pymd-editor
Alternatively you can install from source by following the steps below:
- Clone the repo:
git clone https://github.com/hreikin/pymd-editor.git cd pymd-editor/
- Create and source a Python virtual environment:
python3 -m venv .venv source .venv/bin/activate
- Install requirements with
pip
:pip install -r requirements.txt
To start the standalone editor simply run the following:
python3 -m pymd_editor
To use the ttkbootstrap
styled EditorFrame
in one of your own python scripts:
from pymd_editor.pymd_editor_frame import EditorFrame
import tkinter as tk
import ttkbootstrap as ttk
from ttkbootstrap.constants import *
root = ttk.Window(themename="darkly")
app = EditorFrame(root)
app.pack(fill="both", expand=1)
app.mainloop()
See the open issues for a full list of proposed features (and known issues).
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are greatly appreciated.
If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement". Don't forget to give the project a star! Thanks again!
- Fork the Project
- Create your Feature Branch (
git checkout -b feature/AmazingFeature
) - Commit your Changes (
git commit -m 'Add some AmazingFeature'
) - Push to the Branch (
git push origin feature/AmazingFeature
) - Open a Pull Request
Distributed under the MIT License. See LICENSE.txt
for more information.
Github Link: https://github.com/hreikin/pymd-editor
PyPi Link: https://pypi.org/project/pymd-editor/
Documentation: https://hreikin.github.io/pymd-editor/