Skip to main content

A Python based Markdown editor with HTML preview

Project description


Commits Contributors Forks Stargazers PyPI - Downloads Issues MIT License

A Markdown editor with HTML preview for use in tkinter projects.

About The Project

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.

Built With

Getting Started


To get a local copy up and running choose one of the below install instructions and follow the steps provided.

Install With PIP

The simplest way to install tkintermd is to use pip:

pip install tkintermd

Install From Source

Alternatively you can install from source by following the steps below:

  1. Clone the repo:

    git clone
    cd tkintermd/
  2. Create and source a Python virtual environment:

    python3 -m venv .venv
    source .venv/bin/activate
  3. 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)

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!

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request


Distributed under the MIT License. See LICENSE.txt for more information.


Github Link:
PyPi Link:

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

tkintermd-0.0.6.tar.gz (17.1 kB view hashes)

Uploaded Source

Built Distribution

tkintermd-0.0.6-py3-none-any.whl (15.1 kB view hashes)

Uploaded Python 3

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