Skip to content

Commit

Permalink
Update project README layout, strip out the HTML elements in favour o…
Browse files Browse the repository at this point in the history 
…f the pure markdown.
  • Loading branch information
@hreikin
hreikin committed Apr 9, 2022
1 parent 43a472c commit 50d4837
Showing 1 changed file with 47 additions and 156 deletions.
203 changes: 47 additions & 156 deletions README.md
View file
@@ -1,130 +1,52 @@
<div id="top"></div>
<!--
*** Thanks for checking out the Best-README-Template. If you have a suggestion
*** that would make this better, please fork the repo and create a pull request
*** or simply open an issue with the tag "enhancement".
*** Don't forget to give the project a star!
*** Thanks again! Now go create something AMAZING! :D
-->
# `tkintermd`

<!-- PROJECT SHIELDS -->
<!--
*** I'm using markdown "reference style" links for readability.
*** Reference links are enclosed in brackets [ ] instead of parentheses ( ).
*** See the bottom of this document for the declaration of the reference variables
*** for contributors-url, forks-url, etc. This is an optional, concise syntax you may use.
*** https://www.markdownguide.org/basic-syntax/#reference-style-links
-->
[![Commits][commit-shield]][commit-url]
[![Contributors][contributors-shield]][contributors-url]
[![Forks][forks-shield]][forks-url]
[![Stargazers][stars-shield]][stars-url]
![PyPI - Downloads](https://img.shields.io/pypi/dm/tkintermd?style=for-the-badge) <!-- This link wont work in the reference style. -->
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]

<!-- PROJECT LOGO -->
<br />
<div align="center">
<!-- <a href="https://github.com/hreikin/tkintermd">
<img src="images/logo.png" alt="Logo" width="80" height="80">
</a> -->

<h3 align="center">tkintermd</h3>

<p align="center">
A Markdown editor with HTML preview for use in tkinter projects.
<br />
<a href="https://hreikin.github.io/tkintermd"><strong>Explore the docs »</strong></a>
<br />
<a href="https://hreikin.github.io/tkintermd/pdf/tkintermd-documentation-LATEST.pdf">Download the docs »</a>
<br />
<br />
<!-- <a href="https://github.com/hreikin/tkintermd">View Demo</a> -->
<!-- · -->
<a href="https://pypi.org/project/tkintermd/">PyPi</a>
·
<a href="https://github.com/hreikin/tkintermd/issues">Report Bug</a>
·
<a href="https://github.com/hreikin/tkintermd/issues">Request Feature</a>
</p>
</div>

<!-- TABLE OF CONTENTS -->
<details>
<summary>Table of Contents</summary>
<ol>
<li>
<a href="#about-the-project">About The Project</a>
<ul>
<li><a href="#built-with">Built With</a></li>
</ul>
</li>
<li>
<a href="#getting-started">Getting Started</a>
<ul>
<!-- <li><a href="#prerequisites">Prerequisites</a></li> -->
<li>
<a href="#installation">Installation</a>
<ul>
<li><a href="#install-with-pip">Install With PIP</a></li>
<li><a href="#install-from-source">Install From Source</a></li>
</ul>
</li>
<li>
<a href="#usage">Usage</a>
<ul>
<!-- <li><a href="#standalone">Standalone</a></li> -->
<li><a href="#embedded">Embedded</a></li>
</ul>
</li>
</ul>
</li>
<li><a href="#roadmap">Roadmap</a></li>
<li><a href="#contributing">Contributing</a></li>
<li><a href="#license">License</a></li>
<li><a href="#contact">Contact</a></li>
<!-- <li><a href="#acknowledgments">Acknowledgments</a></li> -->
</ol>
</details>
![Commits](https://img.shields.io/github/commit-activity/m/hreikin/tkintermd?style=for-the-badge)
![Contributors](https://img.shields.io/github/contributors/hreikin/tkintermd.svg?style=for-the-badge)
![Forks](https://img.shields.io/github/forks/hreikin/tkintermd.svg?style=for-the-badge)
![Stargazers](https://img.shields.io/github/stars/hreikin/tkintermd.svg?style=for-the-badge)
![PyPI - Downloads](https://img.shields.io/pypi/dm/tkintermd?style=for-the-badge)
![Issues](https://img.shields.io/github/issues/hreikin/tkintermd.svg?style=for-the-badge)
![MIT License](https://img.shields.io/github/license/hreikin/tkintermd.svg?style=for-the-badge)

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 -->
## About The Project

<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->

A Markdown editor with HTML preview for use in tkinter projects. The editor has
syntax highlighting provided by `Pygments` and the HTML preview window is
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`.

<!-- <p align="right">(<a href="#top">back to top</a>)</p> -->
- 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)
* [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)

<p align="right">(<a href="#top">back to top</a>)</p>
- [Pygments](https://github.com/pygments/pygments)
- [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 -->
## Getting Started
<!-- ### Prerequisites
This is an example of how to list things you need to use the software and how to install them.
* npm
```sh
npm install npm@latest -g
``` -->

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

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`:
The simplest way to install `tkintermd` is to use `pip`:

```sh
pip install tkintermd
Expand All @@ -135,31 +57,34 @@ pip install tkintermd
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
```

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- USAGE EXAMPLES -->
### Usage
## Usage

#### Embedded
### Embedded

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

```python
from tkintermd.tkintermd_frame import TkintermdFrame
from tkintermd.frame import TkintermdFrame

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

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

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- ROADMAP -->
## Roadmap

<!-- - [ ] Feature 1
- [ ] Feature 2
- [ ] Feature 3
- [ ] Nested Feature -->

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).

<p align="right">(<a href="#top">back to top</a>)</p>
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 -->
## Contributing
Expand All @@ -201,47 +118,21 @@ Don't forget to give the project a star! Thanks again!
4. Push to the Branch (`git push origin feature/AmazingFeature`)
5. Open a Pull Request

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- LICENSE -->
## License

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

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- CONTACT -->
## 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/)

<p align="right">(<a href="#top">back to top</a>)</p>

<!-- ACKNOWLEDGMENTS
## Acknowledgments
* []()
* []()
* []()
<p align="right">(<a href="#top">back to top</a>)</p> -->

<!-- MARKDOWN LINKS & IMAGES -->
<!-- https://www.markdownguide.org/basic-syntax/#reference-style-links -->
[contributors-shield]: https://img.shields.io/github/contributors/hreikin/tkintermd.svg?style=for-the-badge
[contributors-url]: https://github.com/hreikin/tkintermd/graphs/contributors
[forks-shield]: https://img.shields.io/github/forks/hreikin/tkintermd.svg?style=for-the-badge
[forks-url]: https://github.com/hreikin/tkintermd/network/members
[stars-shield]: https://img.shields.io/github/stars/hreikin/tkintermd.svg?style=for-the-badge
[stars-url]: https://github.com/hreikin/tkintermd/stargazers
[issues-shield]: https://img.shields.io/github/issues/hreikin/tkintermd.svg?style=for-the-badge
[issues-url]: https://github.com/hreikin/tkintermd/issues
[license-shield]: https://img.shields.io/github/license/hreikin/tkintermd.svg?style=for-the-badge
[license-url]: https://github.com/hreikin/tkintermd/blob/master/LICENSE.txt
<!-- [linkedin-shield]: https://img.shields.io/badge/-LinkedIn-black.svg?style=for-the-badge&logo=linkedin&colorB=555 -->
<!-- [linkedin-url]: https://linkedin.com/in/linkedin_username -->
<!-- [product-screenshot]: images/screenshot.png -->
[commit-shield]: https://img.shields.io/github/commit-activity/m/hreikin/tkintermd?style=for-the-badge
[commit-url]: https://github.com/hreikin/tkintermd/graphs/commit-activity
<!-- ACKNOWLEDGMENTS -->
<!-- ## Acknowledgments -->

<!-- - []() -->
<!-- - []() -->
<!-- - []() -->

0 comments on commit 50d4837

Please sign in to comment.