A tkinter based Markdown editor with HTML preview and export to be used in your projects.
MIT License
tkintermd
A Markdown editor with HTML preview for use in tkinter projects.
An embeddable tkinter based Markdown editor with HTML preview. The editor has
syntax highlighting provided by Pygments
and the HTML preview window is
provided by tkinterweb
.
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 tkintermd
is to use pip
:
pip install tkintermd
Alternatively you can install from source by following the steps below:
Clone the repo:
git clone https://github.com/hreikin/tkintermd.git
cd tkintermd/
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 use the TkintermdFrame
in one of your own python scripts:
from tkintermd.frame import TkintermdFrame
import tkinter as tk
from tkinter.constants import *
root = tk.Tk()
app = TkintermdFrame(root)
app.pack(fill="both", expand=1)
app.mainloop()
For more examples, please refer to the Documentation
Check out the Github Project - tkintermd v0.1.0 for an overview of the work being done towards the release. 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!
git checkout -b feature/AmazingFeature
)git commit -m 'Add some AmazingFeature'
)git push origin feature/AmazingFeature
)Distributed under the MIT License. See LICENSE.txt
for more information.
Github Link: https://github.com/hreikin/tkintermd PyPi Link: https://pypi.org/project/tkintermd/ Documentation: https://hreikin.github.io/tkintermd/