Skip to content

Commit 6957117

Browse files
committed
Update front matter.
1 parent cfafda6 commit 6957117

File tree

7 files changed

+42
-5
lines changed

7 files changed

+42
-5
lines changed

docs/README.md

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,13 +6,10 @@ authors:
66
---
77
# The `tkintermd` Docs
88

9-
<!-- ABOUT THE PROJECT -->
109
## About The Project
1110

12-
<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
13-
1411
An embeddable tkinter based Markdown editor with HTML preview. The editor has
15-
syntax highlighting supplied by `Pygments` and the HTML preview window is
12+
syntax highlighting provided by `Pygments` and the HTML preview window is
1613
provided by `tkinterweb`.
1714

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

docs/contributing-to-tkintermd.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Contributing
3+
summary: Contribution guidelines for tkintermd.
4+
authors:
5+
- hreikin
6+
---
17
## Contributing
28

39
Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

docs/license.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: MIT License
3+
summary: The MIT license.
4+
authors:
5+
- hreikin
6+
---
17
Copyright 2022 @hreikin ([email protected])
28

39
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

docs/reference/README.md

Lines changed: 11 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
1-
# `tkintermd` Reference Documentation
1+
---
2+
title: tkintermd Reference Documentation
3+
summary: API reference for tkintermd.
4+
authors:
5+
- hreikin
6+
---
7+
# `tkintermd` Reference Documentation
8+
9+
- [Constants](./tkintermd-constants.md)
10+
- [TkinterMDFrame](./tkintermd-frame.md)
11+
- [Lexer](tkintermd-lexer.md)

docs/reference/tkintermd-constants.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Constants
3+
summary: API reference for the tkintermd constants and variables.
4+
authors:
5+
- hreikin
6+
---
17
# `constants`
28

39
::: tkintermd.tkintermd_constants

docs/reference/tkintermd-frame.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: TkinterMDFrame
3+
summary: API reference for the TkinterMDFrame.
4+
authors:
5+
- hreikin
6+
---
17
# `TkinterMDFrame`
28

39
::: tkintermd.tkintermd_frame.TkinterMDFrame

docs/reference/tkintermd-lexer.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,9 @@
1+
---
2+
title: Lexer
3+
summary: API reference for the Lexer extension.
4+
authors:
5+
- hreikin
6+
---
17
# `Lexer`
28

39
::: tkintermd.tkintermd_frame.Lexer

0 commit comments

Comments
 (0)