Feature/guide (#7)

* update readme * add changelog * change color
syn54x · Oct 25, 2024 · b06b985 · b06b985
1 parent fcee9f1
commit b06b985
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 10 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,32 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [0.1.1] - 2024-10-25
+
+### Added
+- Pretty output formatting option for CLI documentation
+    - Support for table-based documentation layout
+- Automatic command parsing and documentation generation
+- Integration with Typer's built-in documentation system
+
+### Changed
+- Improved documentation rendering with markdown tables
+- Enhanced support for command arguments and options display
+
+### Fixed
+- Proper handling of optional and required parameters
+- Correct parsing of default values in CLI options
+
+## [0.1.0] - 2024-10-25
+
+### Added
+- Initial release of mkdocs-typer2
+- Basic MkDocs plugin functionality
+- Support for Typer CLI documentation generation
+- Integration with MkDocs Material theme
+- GitHub Actions for testing and deployment
+- Basic test coverage
diff --git a/README.md b/README.md
@@ -43,6 +43,14 @@ plugins:
   - mkdocs-typer2
 ```
 
+The plugin offers a `pretty` option that can be set in your `mkdocs.yml` file to enable pretty documentation.  This will use markdown tables to format the CLI options and arguments instead of lists.
+
+```yaml
+plugins:
+  - mkdocs-typer2:
+      pretty: true
+```
+
 2. In your Markdown files, use the `:::typer` directive to generate documentation for your Typer CLI
 
 ```markdown

diff --git a/docs/index.md b/docs/index.md
@@ -1,8 +1 @@
-| Example Column 1 | Example Column 2 | Example Column 3 |
-|------------------|------------------|------------------|
-| Example Value 1  | Example Value 2  | Example Value 3  |
-| Example Value 4  | Example Value 5  | Example Value 6  |
-| Example Value 7  | Example Value 8  | Example Value 9  |
-
-
 --8<-- "README.md"
diff --git a/mkdocs.yaml b/mkdocs.yaml
@@ -5,7 +5,7 @@ theme:
   name: material
   palette:
     scheme: slate
-    primary: orange
+    primary: cyan
     accent: indigo
   features:
     - announce.dismiss

diff --git a/pyproject.toml b/pyproject.toml
@@ -1,6 +1,6 @@
 [project]
 name = "mkdocs-typer2"
-version = "0.1.0"
+version = "0.1.1"
 description = "Mkdocs plugin for generating Typer CLI docs"
 readme = "README.md"
 requires-python = ">=3.10"

diff --git a/uv.lock b/uv.lock