Skip to content

Commit 2b85327

Browse files
committed
Update documentation to integrate docstring work and recent changes.
1 parent 44b58f9 commit 2b85327

File tree

8 files changed

+23
-14
lines changed

8 files changed

+23
-14
lines changed

CONTRIBUTING.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
## Contributing
1+
# Contributing
22

33
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.
44
See the [open issues](https://github.com/hreikin/tkintermd/issues) for a full list of proposed features (and known issues).

docs/README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@ summary: About tkintermd.
44
authors:
55
- hreikin
66
---
7-
# The `tkintermd` Docs
7+
## The `tkintermd` Docs
88

99
## About The Project
1010

11-
An embeddable tkinter based Markdown editor with HTML preview. The editor has
12-
syntax highlighting provided by `Pygments` and the HTML preview window is
11+
An embeddable tkinter based Markdown editor with HTML preview. The editor has
12+
syntax highlighting provided by `Pygments` and the HTML preview window is
1313
provided by `tkinterweb`.
1414

1515
- Github Link: [https://github.com/hreikin/tkintermd](https://github.com/hreikin/tkintermd)

docs/getting-started/README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,15 +5,17 @@ authors:
55
- hreikin
66
---
77
<!-- GETTING STARTED -->
8-
# Getting Started
8+
## Getting Started
99
<!-- ### Prerequisites
1010
1111
This is an example of how to list things you need to use the software and how to install them.
1212
* npm
1313
```sh
1414
npm install npm@latest -g
1515
``` -->
16+
1617
## Installation
18+
1719
To get a local copy up and running choose one of the below install instructions and follow the steps provided.
1820

1921
### Install With PIP
@@ -29,16 +31,21 @@ pip install tkintermd
2931
Alternatively you can install from source by following the steps below:
3032

3133
1. Clone the repo:
34+
3235
```sh
3336
git clone https://github.com/hreikin/tkintermd.git
3437
cd tkintermd/
3538
```
39+
3640
2. Create and source a Python virtual environment:
41+
3742
```sh
3843
python3 -m venv .venv
3944
source .venv/bin/activate
4045
```
46+
4147
3. Install requirements with `pip`:
48+
4249
```sh
4350
pip install -r requirements.txt
4451
```

docs/license.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,4 +10,4 @@ Permission is hereby granted, free of charge, to any person obtaining a copy of
1010

1111
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
1212

13-
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
13+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

docs/reference/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ summary: API reference for tkintermd.
44
authors:
55
- hreikin
66
---
7-
# `tkintermd` Reference Documentation
7+
## `tkintermd` Reference Documentation
88

99
- [Constants](./tkintermd-constants.md)
1010
- [TkinterMDFrame](./tkintermd-frame.md)
11-
- [Lexer](tkintermd-lexer.md)
11+
- [Lexer](tkintermd-lexer.md)

docs/reference/tkintermd-constants.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ summary: API reference for the tkintermd constants and variables.
44
authors:
55
- hreikin
66
---
7-
# `constants`
7+
## `constants`
88

99
::: tkintermd.tkintermd_constants
1010
handler: python
@@ -13,4 +13,4 @@ authors:
1313
- cur_file -->
1414
rendering:
1515
show_root_heading: true
16-
show_source: false
16+
show_source: false

docs/reference/tkintermd-frame.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ summary: API reference for the TkinterMDFrame.
44
authors:
55
- hreikin
66
---
7-
# `TkinterMDFrame`
7+
## `TkinterMDFrame`
88

99
::: tkintermd.tkintermd_frame.TkinterMDFrame
1010
handler: python
@@ -22,6 +22,8 @@ authors:
2222
- load_style
2323
- check_markdown
2424
- apply_markdown_both_sides
25+
- remove_markdown_both_sides
26+
- check_bold_italic
2527
rendering:
2628
show_root_heading: true
27-
show_source: false
29+
show_source: false

docs/reference/tkintermd-lexer.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ summary: API reference for the Lexer extension.
44
authors:
55
- hreikin
66
---
7-
# `Lexer`
7+
## `Lexer`
88

99
::: tkintermd.tkintermd_frame.Lexer
1010
handler: python
@@ -24,4 +24,4 @@ authors:
2424
- apply_markdown_both_sides -->
2525
rendering:
2626
show_root_heading: true
27-
show_source: false
27+
show_source: false

0 commit comments

Comments
 (0)