Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/hreikin/tkintermd
A tkinter based Markdown editor with HTML preview and export to be used in your projects.
https://github.com/hreikin/tkintermd
markdown markdown-editor pygments python python-markdown python3 tkinter tkinter-gui tkinterweb
Last synced: 2 days ago
JSON representation
A tkinter based Markdown editor with HTML preview and export to be used in your projects.
- Host: GitHub
- URL: https://github.com/hreikin/tkintermd
- Owner: hreikin
- License: mit
- Created: 2022-04-02T16:32:32.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-11-29T00:11:44.000Z (10 months ago)
- Last Synced: 2024-08-17T18:50:29.536Z (about 1 month ago)
- Topics: markdown, markdown-editor, pygments, python, python-markdown, python3, tkinter, tkinter-gui, tkinterweb
- Language: Python
- Homepage: https://hreikin.github.io/tkintermd/
- Size: 822 KB
- Stars: 16
- Watchers: 2
- Forks: 4
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# `tkintermd`
A Markdown editor with HTML preview for use in tkinter projects.
- [Explore the docs](https://hreikin.github.io/tkintermd)
- [Download the docs](https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf)
- [PyPi](https://pypi.org/project/tkintermd/)
- [Issues](https://github.com/hreikin/tkintermd/issues)
## 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`.
- Github v0.1.0 Project: [Github Project - tkintermd v0.1.0](https://github.com/users/hreikin/projects/1/)
- Github Discussion: [Github Discussions](https://github.com/hreikin/tkintermd/discussions)
- PyPi Link: [https://pypi.org/project/tkintermd/](https://pypi.org/project/tkintermd/)
- PDF Documentation: [https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf](https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf)
### Built With
- [Pygments](https://github.com/pygments/pygments)
- [Pymdownx](https://facelessuser.github.io/pymdown-extensions/)
- [Python](https://www.python.org/)
- [Python Markdown](https://github.com/Python-Markdown/markdown)
- [tkinter](https://docs.python.org/3/library/tkinter.html)
- [tkinterweb](https://github.com/Andereoo/TkinterWeb)
## 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 `tkintermd` is to use `pip`:
```sh
pip install tkintermd
```
#### Install From Source
Alternatively you can install from source by following the steps below:
1. Clone the repo:
```sh
git clone https://github.com/hreikin/tkintermd.git
cd tkintermd/
```
2. Create and source a Python virtual environment:
```sh
python3 -m venv .venv
source .venv/bin/activate
```
3. Install requirements with `pip`:
```sh
pip install -r requirements.txt
```
## Usage
### Embedded
To use the `TkintermdFrame` in one of your own python scripts:
```python
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](https://hreikin.github.io/tkintermd)_
## Roadmap
Check out the [Github Project - tkintermd v0.1.0](https://github.com/users/hreikin/projects/1/)
for an overview of the work being done towards the release. See the [open issues](https://github.com/hreikin/tkintermd/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!
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
## License
Distributed under the MIT License. See `LICENSE.txt` for more information.
## Contact
Github Link: [https://github.com/hreikin/tkintermd](https://github.com/hreikin/tkintermd)
PyPi Link: [https://pypi.org/project/tkintermd/](https://pypi.org/project/tkintermd/)
Documentation: [https://hreikin.github.io/tkintermd/](https://hreikin.github.io/tkintermd/)