{"id":15048831,"url":"https://github.com/hreikin/tkintermd","last_synced_at":"2026-03-16T09:03:55.029Z","repository":{"id":38454128,"uuid":"477110979","full_name":"hreikin/tkintermd","owner":"hreikin","description":"A tkinter based Markdown editor with HTML preview and export to be used in your projects.","archived":false,"fork":false,"pushed_at":"2023-11-29T00:11:44.000Z","size":842,"stargazers_count":19,"open_issues_count":12,"forks_count":4,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-08-18T18:47:08.925Z","etag":null,"topics":["markdown","markdown-editor","pygments","python","python-markdown","python3","tkinter","tkinter-gui","tkinterweb"],"latest_commit_sha":null,"homepage":"https://hreikin.github.io/tkintermd/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hreikin.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-04-02T16:32:32.000Z","updated_at":"2025-04-26T22:07:35.000Z","dependencies_parsed_at":"2023-01-25T05:10:20.048Z","dependency_job_id":"37ea9766-b89a-46b1-9120-bc9767751fde","html_url":"https://github.com/hreikin/tkintermd","commit_stats":{"total_commits":152,"total_committers":3,"mean_commits":"50.666666666666664","dds":0.08552631578947367,"last_synced_commit":"f94db9ffc727ce2b4bf3ddbdbc106c1084822dc5"},"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"purl":"pkg:github/hreikin/tkintermd","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hreikin%2Ftkintermd","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hreikin%2Ftkintermd/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hreikin%2Ftkintermd/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hreikin%2Ftkintermd/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hreikin","download_url":"https://codeload.github.com/hreikin/tkintermd/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hreikin%2Ftkintermd/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":273650369,"owners_count":25143837,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-09-04T02:00:08.968Z","response_time":61,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["markdown","markdown-editor","pygments","python","python-markdown","python3","tkinter","tkinter-gui","tkinterweb"],"created_at":"2024-09-24T21:16:42.553Z","updated_at":"2026-03-16T09:03:54.992Z","avatar_url":"https://github.com/hreikin.png","language":"Python","readme":"# `tkintermd`\n\n\u003c!-- PROJECT SHIELDS --\u003e\n![Commits](https://img.shields.io/github/commit-activity/m/hreikin/tkintermd?style=for-the-badge)\n![Contributors](https://img.shields.io/github/contributors/hreikin/tkintermd.svg?style=for-the-badge)\n![Forks](https://img.shields.io/github/forks/hreikin/tkintermd.svg?style=for-the-badge)\n![Stargazers](https://img.shields.io/github/stars/hreikin/tkintermd.svg?style=for-the-badge)\n![PyPI - Downloads](https://img.shields.io/pypi/dm/tkintermd?style=for-the-badge)\n![Issues](https://img.shields.io/github/issues/hreikin/tkintermd.svg?style=for-the-badge)\n![MIT License](https://img.shields.io/github/license/hreikin/tkintermd.svg?style=for-the-badge)\n\nA Markdown editor with HTML preview for use in tkinter projects.\n\n- [Explore the docs](https://hreikin.github.io/tkintermd)\n- [Download the docs](https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf)\n- [PyPi](https://pypi.org/project/tkintermd/)\n- [Issues](https://github.com/hreikin/tkintermd/issues)\n\n\u003c!-- ABOUT THE PROJECT --\u003e\n## About The Project\n\nAn embeddable tkinter based Markdown editor with HTML preview. The editor has\nsyntax highlighting provided by `Pygments` and the HTML preview window is\nprovided by `tkinterweb`.\n\n- Github v0.1.0 Project: [Github Project - tkintermd v0.1.0](https://github.com/users/hreikin/projects/1/)  \n- Github Discussion: [Github Discussions](https://github.com/hreikin/tkintermd/discussions)  \n- PyPi Link: [https://pypi.org/project/tkintermd/](https://pypi.org/project/tkintermd/)  \n- PDF Documentation: [https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf](https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf)\n\n### Built With\n\n- [Pygments](https://github.com/pygments/pygments)\n- [Pymdownx](https://facelessuser.github.io/pymdown-extensions/)\n- [Python](https://www.python.org/)\n- [Python Markdown](https://github.com/Python-Markdown/markdown)\n- [tkinter](https://docs.python.org/3/library/tkinter.html)\n- [tkinterweb](https://github.com/Andereoo/TkinterWeb)\n\n\u003c!-- GETTING STARTED --\u003e\n## Getting Started\n\n### Installation\n\nTo get a local copy up and running choose one of the below install instructions\nand follow the steps provided.\n\n#### Install With PIP\n\nThe simplest way to install `tkintermd` is to use `pip`:\n\n```sh\npip install tkintermd\n```\n\n#### Install From Source\n\nAlternatively you can install from source by following the steps below:\n\n1. Clone the repo:\n\n   ```sh\n   git clone https://github.com/hreikin/tkintermd.git\n   cd tkintermd/\n   ```\n\n2. Create and source a Python virtual environment:\n\n   ```sh\n   python3 -m venv .venv\n   source .venv/bin/activate\n   ```\n\n3. Install requirements with `pip`:\n\n   ```sh\n   pip install -r requirements.txt\n   ```\n\n\u003c!-- USAGE EXAMPLES --\u003e\n## Usage\n\n### Embedded\n\nTo use the `TkintermdFrame` in one of your own python scripts:\n\n```python\nfrom tkintermd.frame import TkintermdFrame\n\nimport tkinter as tk\nfrom tkinter.constants import *\n\nroot = tk.Tk()\napp = TkintermdFrame(root)\napp.pack(fill=\"both\", expand=1)\napp.mainloop()\n```\n\n_For more examples, please refer to the [Documentation](https://hreikin.github.io/tkintermd)_\n\n\u003c!-- ROADMAP --\u003e\n## Roadmap\n\nCheck out the [Github Project - tkintermd v0.1.0](https://github.com/users/hreikin/projects/1/)\nfor an overview of the work being done towards the release. See the [open issues](https://github.com/hreikin/tkintermd/issues)\nfor a full list of proposed features (and known issues).\n\n\u003c!-- CONTRIBUTING --\u003e\n## Contributing\n\nContributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.\n\nIf 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\".\nDon't forget to give the project a star! Thanks again!\n\n1. Fork the Project\n2. Create your Feature Branch (`git checkout -b feature/AmazingFeature`)\n3. Commit your Changes (`git commit -m 'Add some AmazingFeature'`)\n4. Push to the Branch (`git push origin feature/AmazingFeature`)\n5. Open a Pull Request\n\n\u003c!-- LICENSE --\u003e\n## License\n\nDistributed under the MIT License. See `LICENSE.txt` for more information.\n\n\u003c!-- CONTACT --\u003e\n## Contact\n\nGithub Link: [https://github.com/hreikin/tkintermd](https://github.com/hreikin/tkintermd)  \nPyPi Link: [https://pypi.org/project/tkintermd/](https://pypi.org/project/tkintermd/)  \nDocumentation: [https://hreikin.github.io/tkintermd/](https://hreikin.github.io/tkintermd/)\n\n\u003c!-- ACKNOWLEDGMENTS --\u003e\n\u003c!-- ## Acknowledgments --\u003e\n\n\u003c!-- - []() --\u003e\n\u003c!-- - []() --\u003e\n\u003c!-- - []() --\u003e\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhreikin%2Ftkintermd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhreikin%2Ftkintermd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhreikin%2Ftkintermd/lists"}