Skip to content

Commit

Permalink
Update documentation with new links to github project and discussions.
Browse files Browse the repository at this point in the history
  • Loading branch information
hreikin committed Apr 9, 2022
1 parent 6cd5869 commit 128d675
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 7 deletions.
3 changes: 2 additions & 1 deletion docs/README.md
Expand Up @@ -10,7 +10,8 @@ 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 Link: [https://github.com/hreikin/tkintermd](https://github.com/hreikin/tkintermd)
- 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)

Expand Down
13 changes: 8 additions & 5 deletions docs/contributing-to-tkintermd.md
Expand Up @@ -4,13 +4,16 @@ summary: Contribution guidelines for tkintermd.
authors:
- hreikin
---
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).
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).

Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.
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!
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`)
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/README.md
Expand Up @@ -7,5 +7,5 @@ authors:
## `tkintermd`

- [Constants](./tkintermd-constants.md)
- [TkintermdFrame](./tkintermd-frame.md)
- [Lexer](tkintermd-lexer.md)
- [TkintermdFrame](./tkintermd-frame.md)

0 comments on commit 128d675

Please sign in to comment.