A Python based Markdown editor with HTML preview
Project description
tkintermd
An embeddable tkinter based Markdown editor with HTML preview.
PyPi
·
Report Bug
·
Request Feature
Table of Contents
About The Project
An embeddable tkinter based Markdown editor with HTML preview.
Built With
Getting Started
Installation
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 the PyMD Editor is to use pip
:
pip install tkintermd
Install From Source
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
Usage
Embedded
To use tkinter
styled tkintermd_frame
in one of your own python scripts:
from tkintermd.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()
Roadmap
See the open issues for a full list of proposed features (and known issues).
Contributing
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
License
Distributed under the MIT License. See LICENSE.txt
for more information.
Contact
Github Link: https://github.com/hreikin/tkintermd
PyPi Link: https://pypi.org/project/tkintermd/
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
Built Distribution
Hashes for tkintermd-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 4cbcdc59b4532c5be88fc66849917e5a2d0761283d3acbe5846b077e2faf1cd9 |
|
MD5 | eee7764783327d5b82b6c0e689fd23b9 |
|
BLAKE2b-256 | 9949dc8f9571c8130e0f5fcec5c68aa76990773881a511547ce16f7d804f2f6b |