Skip to content

Commit 6c10b61

Browse files
hbregaladhbregalad
authored
Merge branch 'hreikin:main' into HTML-source-with-scrollbars-suggestion
2 parents cce5db7 + 383fc75 commit 6c10b61

File tree

10 files changed

+177
-237
lines changed

10 files changed

+177
-237
lines changed

‎.github/workflows/check-pr.yml

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
name: Check Merged Build On Pull Request
2+
3+
on:
4+
pull_request:
5+
branches: main
6+
7+
jobs:
8+
deploy:
9+
runs-on: ubuntu-latest
10+
steps:
11+
- name: Checkout Merged Repository Source
12+
uses: actions/checkout@v3
13+
- name: Setup Python
14+
uses: actions/setup-python@v3
15+
with:
16+
python-version: "3.x"
17+
- name: Install Build Dependencies
18+
run: |
19+
python -m pip install --upgrade pip
20+
pip install -r requirements-dev.txt
21+
- name: Build Package
22+
run: python -m build
23+
- name: Install Docs Build Requirements
24+
run: sudo apt-get install -y libpango-1.0-0 libharfbuzz0b libpangoft2-1.0-0 libffi-dev libjpeg-dev libopenjp2-7-dev
25+
- name: Build Docs
26+
run: mkdocs build

‎README.md

Lines changed: 47 additions & 156 deletions
Original file line numberDiff line numberDiff line change
@@ -1,130 +1,52 @@
1-
<div id="top"></div>
2-
<!--
3-
*** Thanks for checking out the Best-README-Template. If you have a suggestion
4-
*** that would make this better, please fork the repo and create a pull request
5-
*** or simply open an issue with the tag "enhancement".
6-
*** Don't forget to give the project a star!
7-
*** Thanks again! Now go create something AMAZING! :D
8-
-->
1+
# `tkintermd`
92

103
<!-- PROJECT SHIELDS -->
11-
<!--
12-
*** I'm using markdown "reference style" links for readability.
13-
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
14-
*** See the bottom of this document for the declaration of the reference variables
15-
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
16-
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
17-
-->
18-
[![Commits][commit-shield]][commit-url]
19-
[![Contributors][contributors-shield]][contributors-url]
20-
[![Forks][forks-shield]][forks-url]
21-
[![Stargazers][stars-shield]][stars-url]
22-
![PyPI - Downloads](https://img.shields.io/pypi/dm/tkintermd?style=for-the-badge) <!-- This link wont work in the reference style. -->
23-
[![Issues][issues-shield]][issues-url]
24-
[![MIT License][license-shield]][license-url]
25-
26-
<!-- PROJECT LOGO -->
27-
<br />
28-
<div align="center">
29-
<!-- <a href="https://github.com/hreikin/tkintermd">
30-
<img src="images/logo.png" alt="Logo" width="80" height="80">
31-
</a> -->
32-
33-
<h3 align="center">tkintermd</h3>
34-
35-
<p align="center">
36-
A Markdown editor with HTML preview for use in tkinter projects.
37-
<br />
38-
<a href="https://hreikin.github.io/tkintermd"><strong>Explore the docs »</strong></a>
39-
<br />
40-
<a href="https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf">Download the docs »</a>
41-
<br />
42-
<br />
43-
<!-- <a href="https://github.com/hreikin/tkintermd">View Demo</a> -->
44-
<!-- · -->
45-
<a href="https://pypi.org/project/tkintermd/">PyPi</a>
46-
·
47-
<a href="https://github.com/hreikin/tkintermd/issues">Report Bug</a>
48-
·
49-
<a href="https://github.com/hreikin/tkintermd/issues">Request Feature</a>
50-
</p>
51-
</div>
52-
53-
<!-- TABLE OF CONTENTS -->
54-
<details>
55-
<summary>Table of Contents</summary>
56-
<ol>
57-
<li>
58-
<a href="#about-the-project">About The Project</a>
59-
<ul>
60-
<li><a href="#built-with">Built With</a></li>
61-
</ul>
62-
</li>
63-
<li>
64-
<a href="#getting-started">Getting Started</a>
65-
<ul>
66-
<!-- <li><a href="#prerequisites">Prerequisites</a></li> -->
67-
<li>
68-
<a href="#installation">Installation</a>
69-
<ul>
70-
<li><a href="#install-with-pip">Install With PIP</a></li>
71-
<li><a href="#install-from-source">Install From Source</a></li>
72-
</ul>
73-
</li>
74-
<li>
75-
<a href="#usage">Usage</a>
76-
<ul>
77-
<!-- <li><a href="#standalone">Standalone</a></li> -->
78-
<li><a href="#embedded">Embedded</a></li>
79-
</ul>
80-
</li>
81-
</ul>
82-
</li>
83-
<li><a href="#roadmap">Roadmap</a></li>
84-
<li><a href="#contributing">Contributing</a></li>
85-
<li><a href="#license">License</a></li>
86-
<li><a href="#contact">Contact</a></li>
87-
<!-- <li><a href="#acknowledgments">Acknowledgments</a></li> -->
88-
</ol>
89-
</details>
4+
![Commits](https://img.shields.io/github/commit-activity/m/hreikin/tkintermd?style=for-the-badge)
5+
![Contributors](https://img.shields.io/github/contributors/hreikin/tkintermd.svg?style=for-the-badge)
6+
![Forks](https://img.shields.io/github/forks/hreikin/tkintermd.svg?style=for-the-badge)
7+
![Stargazers](https://img.shields.io/github/stars/hreikin/tkintermd.svg?style=for-the-badge)
8+
![PyPI - Downloads](https://img.shields.io/pypi/dm/tkintermd?style=for-the-badge)
9+
![Issues](https://img.shields.io/github/issues/hreikin/tkintermd.svg?style=for-the-badge)
10+
![MIT License](https://img.shields.io/github/license/hreikin/tkintermd.svg?style=for-the-badge)
11+
12+
A Markdown editor with HTML preview for use in tkinter projects.
13+
14+
- [Explore the docs](https://hreikin.github.io/tkintermd)
15+
- [Download the docs](https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf)
16+
- [PyPi](https://pypi.org/project/tkintermd/)
17+
- [Issues](https://github.com/hreikin/tkintermd/issues)
9018

9119
<!-- ABOUT THE PROJECT -->
9220
## About The Project
9321

94-
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
95-
96-
A Markdown editor with HTML preview for use in tkinter projects. The editor has
97-
syntax highlighting provided by `Pygments` and the HTML preview window is
22+
An embeddable tkinter based Markdown editor with HTML preview. The editor has
23+
syntax highlighting provided by `Pygments` and the HTML preview window is
9824
provided by `tkinterweb`.
9925

100-
<!-- <p align="right">(<a href="#top">back to top</a>)</p> -->
26+
- Github v0.1.0 Project: [Github Project - tkintermd v0.1.0](https://github.com/users/hreikin/projects/1/)
27+
- Github Discussion: [Github Discussions](https://github.com/hreikin/tkintermd/discussions)
28+
- PyPi Link: [https://pypi.org/project/tkintermd/](https://pypi.org/project/tkintermd/)
29+
- PDF Documentation: [https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf](https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf)
10130

10231
### Built With
10332

104-
* [Pygments](https://github.com/pygments/pygments)
105-
* [Python](https://www.python.org/)
106-
* [Python Markdown](https://github.com/Python-Markdown/markdown)
107-
* [tkinter](https://docs.python.org/3/library/tkinter.html)
108-
* [tkinterweb](https://github.com/Andereoo/TkinterWeb)
109-
110-
<p align="right">(<a href="#top">back to top</a>)</p>
33+
- [Pygments](https://github.com/pygments/pygments)
34+
- [Python](https://www.python.org/)
35+
- [Python Markdown](https://github.com/Python-Markdown/markdown)
36+
- [tkinter](https://docs.python.org/3/library/tkinter.html)
37+
- [tkinterweb](https://github.com/Andereoo/TkinterWeb)
11138

11239
<!-- GETTING STARTED -->
11340
## Getting Started
114-
<!-- ### Prerequisites
115-
116-
This is an example of how to list things you need to use the software and how to install them.
117-
* npm
118-
```sh
119-
npm install npm@latest -g
120-
``` -->
12141

12242
### Installation
123-
To get a local copy up and running choose one of the below install instructions and follow the steps provided.
43+
44+
To get a local copy up and running choose one of the below install instructions
45+
and follow the steps provided.
12446

12547
#### Install With PIP
12648

127-
The simplest way to install the PyMD Editor is to use `pip`:
49+
The simplest way to install `tkintermd` is to use `pip`:
12850

12951
```sh
13052
pip install tkintermd
@@ -135,31 +57,34 @@ pip install tkintermd
13557
Alternatively you can install from source by following the steps below:
13658

13759
1. Clone the repo:
60+
13861
```sh
13962
git clone https://github.com/hreikin/tkintermd.git
14063
cd tkintermd/
14164
```
65+
14266
2. Create and source a Python virtual environment:
67+
14368
```sh
14469
python3 -m venv .venv
14570
source .venv/bin/activate
14671
```
72+
14773
3. Install requirements with `pip`:
74+
14875
```sh
14976
pip install -r requirements.txt
15077
```
15178

152-
<p align="right">(<a href="#top">back to top</a>)</p>
153-
15479
<!-- USAGE EXAMPLES -->
155-
### Usage
80+
## Usage
15681

157-
#### Embedded
82+
### Embedded
15883

15984
To use the `TkintermdFrame` in one of your own python scripts:
16085

16186
```python
162-
from tkintermd.tkintermd_frame import TkintermdFrame
87+
from tkintermd.frame import TkintermdFrame
16388

16489
import tkinter as tk
16590
from tkinter.constants import *
@@ -172,20 +97,12 @@ app.mainloop()
17297

17398
_For more examples, please refer to the [Documentation](https://hreikin.github.io/tkintermd)_
17499

175-
<p align="right">(<a href="#top">back to top</a>)</p>
176-
177100
<!-- ROADMAP -->
178101
## Roadmap
179102

180-
<!-- - [ ] Feature 1
181-
- [ ] Feature 2
182-
- [ ] Feature 3
183-
- [ ] Nested Feature -->
184-
185-
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.
186-
See the [open issues](https://github.com/hreikin/tkintermd/issues) for a full list of proposed features (and known issues).
187-
188-
<p align="right">(<a href="#top">back to top</a>)</p>
103+
Check out the [Github Project - tkintermd v0.1.0](https://github.com/users/hreikin/projects/1/)
104+
for an overview of the work being done towards the release. See the [open issues](https://github.com/hreikin/tkintermd/issues)
105+
for a full list of proposed features (and known issues).
189106

190107
<!-- CONTRIBUTING -->
191108
## Contributing
@@ -201,47 +118,21 @@ Don't forget to give the project a star! Thanks again!
201118
4. Push to the Branch (`git push origin feature/AmazingFeature`)
202119
5. Open a Pull Request
203120

204-
<p align="right">(<a href="#top">back to top</a>)</p>
205-
206121
<!-- LICENSE -->
207122
## License
208123

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

211-
<p align="right">(<a href="#top">back to top</a>)</p>
212-
213126
<!-- CONTACT -->
214127
## Contact
215128

216129
Github Link: [https://github.com/hreikin/tkintermd](https://github.com/hreikin/tkintermd)
217130
PyPi Link: [https://pypi.org/project/tkintermd/](https://pypi.org/project/tkintermd/)
218131
Documentation: [https://hreikin.github.io/tkintermd/](https://hreikin.github.io/tkintermd/)
219132

220-
<p align="right">(<a href="#top">back to top</a>)</p>
221-
222-
<!-- ACKNOWLEDGMENTS
223-
## Acknowledgments
224-
225-
* []()
226-
* []()
227-
* []()
228-
229-
<p align="right">(<a href="#top">back to top</a>)</p> -->
230-
231-
<!-- MARKDOWN LINKS & IMAGES -->
232-
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
233-
[contributors-shield]: https://img.shields.io/github/contributors/hreikin/tkintermd.svg?style=for-the-badge
234-
[contributors-url]: https://github.com/hreikin/tkintermd/graphs/contributors
235-
[forks-shield]: https://img.shields.io/github/forks/hreikin/tkintermd.svg?style=for-the-badge
236-
[forks-url]: https://github.com/hreikin/tkintermd/network/members
237-
[stars-shield]: https://img.shields.io/github/stars/hreikin/tkintermd.svg?style=for-the-badge
238-
[stars-url]: https://github.com/hreikin/tkintermd/stargazers
239-
[issues-shield]: https://img.shields.io/github/issues/hreikin/tkintermd.svg?style=for-the-badge
240-
[issues-url]: https://github.com/hreikin/tkintermd/issues
241-
[license-shield]: https://img.shields.io/github/license/hreikin/tkintermd.svg?style=for-the-badge
242-
[license-url]: https://github.com/hreikin/tkintermd/blob/master/LICENSE.txt
243-
<!-- [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 -->
244-
<!-- [linkedin-url]: https://linkedin.com/in/linkedin_username -->
245-
<!-- [product-screenshot]: images/screenshot.png -->
246-
[commit-shield]: https://img.shields.io/github/commit-activity/m/hreikin/tkintermd?style=for-the-badge
247-
[commit-url]: https://github.com/hreikin/tkintermd/graphs/commit-activity
133+
<!-- ACKNOWLEDGMENTS -->
134+
<!-- ## Acknowledgments -->
135+
136+
<!-- - []() -->
137+
<!-- - []() -->
138+
<!-- - []() -->

‎docs/README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,8 @@ syntax highlighting provided by `Pygments` and the HTML preview window is
1111
provided by `tkinterweb`.
1212

1313
- Github Link: [https://github.com/hreikin/tkintermd](https://github.com/hreikin/tkintermd)
14+
- Github v0.1.0 Project: [Github Project - tkintermd v0.1.0](https://github.com/users/hreikin/projects/1/)
15+
- Github Discussion: [Github Discussions](https://github.com/hreikin/tkintermd/discussions)
1416
- PyPi Link: [https://pypi.org/project/tkintermd/](https://pypi.org/project/tkintermd/)
1517
- PDF Documentation: [https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf](https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf)
1618

‎docs/contributing-to-tkintermd.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,16 @@ summary: Contribution guidelines for tkintermd.
44
authors:
55
- hreikin
66
---
7-
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.
8-
See the [open issues](https://github.com/hreikin/tkintermd/issues) for a full list of proposed features (and known issues).
7+
Check out the [Github Project - tkintermd v0.1.0](https://github.com/users/hreikin/projects/1/)
8+
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).
99

10-
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
10+
Contributions are what make the open source community such an amazing place to
11+
learn, inspire, and create. Any contributions you make are
12+
**greatly appreciated**.
1113

12-
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".
13-
Don't forget to give the project a star! Thanks again!
14+
If you have a suggestion that would make this better, please fork the repo and
15+
create a pull request. You can also simply open an issue with the tag
16+
"enhancement". Don't forget to give the project a star! Thanks again!
1417

1518
- Fork the Project
1619
- Create your Feature Branch (`git checkout -b feature/AmazingFeature`)

‎docs/getting-started/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ To get a local copy up and running choose one of the below install instructions
1010

1111
### Install With PIP
1212

13-
The simplest way to install tkintermd is to use `pip`:
13+
The simplest way to install `tkintermd` is to use `pip`:
1414

1515
```sh
1616
pip install tkintermd

‎docs/reference/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@ authors:
77
## `tkintermd`
88

99
- [Constants](./tkintermd-constants.md)
10-
- [TkintermdFrame](./tkintermd-frame.md)
1110
- [Lexer](tkintermd-lexer.md)
11+
- [TkintermdFrame](./tkintermd-frame.md)

‎mkdocs.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -121,7 +121,7 @@ nav:
121121
- Getting Started: 'getting-started/README.md'
122122
- Reference:
123123
- Reference: 'reference/README.md'
124-
- TkintermdFrame: 'reference/tkintermd-frame.md'
125-
- Lexer: 'reference/tkintermd-lexer.md'
126124
- Constants: 'reference/tkintermd-constants.md'
125+
- Lexer: 'reference/tkintermd-lexer.md'
126+
- TkintermdFrame: 'reference/tkintermd-frame.md'
127127

0 commit comments

Comments
 (0)