Update front matter.

hreikin · Apr 3, 2022 · 6957117 · 6957117
1 parent cfafda6
commit 6957117
Show file tree

Hide file tree

Showing 7 changed files with 42 additions and 5 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -6,13 +6,10 @@ authors:
 ---
 # The `tkintermd` Docs
 
-<!-- ABOUT THE PROJECT -->
 ## About The Project
 
-<!-- [![Product Name Screen Shot][product-screenshot]](https://example.com) -->
-
 An embeddable tkinter based Markdown editor with HTML preview. The editor has 
-syntax highlighting supplied by `Pygments` and the HTML preview window is 
+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)  

diff --git a/docs/contributing-to-tkintermd.md b/docs/contributing-to-tkintermd.md
@@ -1,3 +1,9 @@
+---
+title: Contributing
+summary: Contribution guidelines for tkintermd.
+authors:
+    - hreikin
+---
 ## Contributing
 
 Contributions are what make the open source community such an amazing place to learn, inspire, and create. Any contributions you make are **greatly appreciated**.

diff --git a/docs/license.md b/docs/license.md
@@ -1,3 +1,9 @@
+---
+title: MIT License
+summary: The MIT license.
+authors:
+    - hreikin
+---
 Copyright 2022 @hreikin (hreikin@gmail.com)
 
 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:

diff --git a/docs/reference/README.md b/docs/reference/README.md
@@ -1 +1,11 @@
-# `tkintermd` Reference Documentation
+---
+title: tkintermd Reference Documentation
+summary: API reference for tkintermd.
+authors:
+    - hreikin
+---
+# `tkintermd` Reference Documentation
+
+- [Constants](./tkintermd-constants.md)
+- [TkinterMDFrame](./tkintermd-frame.md)
+- [Lexer](tkintermd-lexer.md)
diff --git a/docs/reference/tkintermd-constants.md b/docs/reference/tkintermd-constants.md
@@ -1,3 +1,9 @@
+---
+title: Constants
+summary: API reference for the tkintermd constants and variables.
+authors:
+    - hreikin
+---
 # `constants`
 
 ::: tkintermd.tkintermd_constants

diff --git a/docs/reference/tkintermd-frame.md b/docs/reference/tkintermd-frame.md
@@ -1,3 +1,9 @@
+---
+title: TkinterMDFrame
+summary: API reference for the TkinterMDFrame.
+authors:
+    - hreikin
+---
 # `TkinterMDFrame`
 
 ::: tkintermd.tkintermd_frame.TkinterMDFrame

diff --git a/docs/reference/tkintermd-lexer.md b/docs/reference/tkintermd-lexer.md
@@ -1,3 +1,9 @@
+---
+title: Lexer
+summary: API reference for the Lexer extension.
+authors:
+    - hreikin
+---
 # `Lexer`
 
 ::: tkintermd.tkintermd_frame.Lexer