From 0f44674ce60d0c12c0cefe7b255f137c74372318 Mon Sep 17 00:00:00 2001 From: Eli Salamie Date: Sun, 23 Feb 2025 18:43:01 -0600 Subject: [PATCH 1/2] Refactor README layout and update logo source --- README.md | 45 ++++++++++++++------- docs/assets/logo.svg | 79 +++++++++++++++++++++++++++++++++++++ pyproject.toml | 2 +- src/markitecture/version.py | 2 +- 4 files changed, 111 insertions(+), 17 deletions(-) create mode 100644 docs/assets/logo.svg diff --git a/README.md b/README.md index bcebc24..aaf6078 100644 --- a/README.md +++ b/README.md @@ -1,46 +1,60 @@ -
+
+ - - - - markitecture Logo + + + markitecture Logo -

- The Architecture of Better Documentation. -

+

Markitecture

+ +The Architecture of Better Documentation. +

- Markitecture: The Python toolkit that empowers modular Markdown workflows. + Markdown tools for modular workflows and content management.

- +

GitHub Actions - Coverage + Coverage - PyPI Version + PyPI Version - + MIT License

+[Documentation][markitecture] · [Contribute][markitecture] · [Report Bug][github-issues] · [Request Feature][github-issues] + + +
separator
- ## What is Markitecture? @@ -231,6 +245,7 @@ Released under the [MIT][mit-license] license. [markitecture]: https://github.com/eli64s/markitecture [github-issues]: https://github.com/eli64s/markitecture/issues [github-pulls]: https://github.com/eli64s/markitecture/pulls +[contributing]: https://github.com/eli64s/markitecture/blob/main/CONTRIBUTING.md [mit-license]: https://github.com/eli64s/markitecture/blob/main/LICENSE [examples]: https://github.com/eli64s/markitecture/tree/main/examples diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg new file mode 100644 index 0000000..b4e72af --- /dev/null +++ b/docs/assets/logo.svg @@ -0,0 +1,79 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/pyproject.toml b/pyproject.toml index c5c8715..956f8dc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -4,7 +4,7 @@ requires = [ "hatch-fancy-pypi-readme", "hatchling" ] [project] name = "markitecture" -description = "❂ Markdown tools for modular and flexible docs: link validation, reference link conversion, text splitting, & more." +description = "Markdown tools for modular workflows and content management." dynamic = ["readme", "version"] keywords = [ "automated-markdown", diff --git a/src/markitecture/version.py b/src/markitecture/version.py index 77fc1e2..93824aa 100644 --- a/src/markitecture/version.py +++ b/src/markitecture/version.py @@ -1 +1 @@ -__version__ = "0.2.31" +__version__ = "0.2.32" From 26eecae3d9a3ae475ff3099ef6c56fd329291f3d Mon Sep 17 00:00:00 2001 From: Eli Salamie Date: Mon, 24 Feb 2025 00:57:31 -0600 Subject: [PATCH 2/2] Project clean up. --- .github/workflows/ci.yml | 2 +- .gitignore | 8 +++----- README.md | 33 ++++++++++++++++++--------------- docs/assets/line.svg | 8 ++++---- docs/assets/logo.svg | 39 --------------------------------------- docs/assets/shield.svg | 8 ++++---- notebooks/.gtikeep | 0 7 files changed, 30 insertions(+), 68 deletions(-) create mode 100644 notebooks/.gtikeep diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9fcf163..6b9ac06 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -54,7 +54,7 @@ jobs: - name: Run tests with coverage run: | - uv run pytest --config-file="pyproject.toml" --cov-config="pyproject.toml" + uv run pytest --config-file="pyproject.toml" - name: Verify coverage report run: | diff --git a/.gitignore b/.gitignore index 1a935a3..9a22b38 100644 --- a/.gitignore +++ b/.gitignore @@ -33,10 +33,8 @@ ENV/ .ruff_cache/ .reports/ site/ -.continuerules -# -- Markitect --------- +# Markitecture +.continuerules markitect.yml -.markitecture/ -notebooks/ -.github/workflows/tag-version.yml +docs/mkdocs/ diff --git a/README.md b/README.md index aaf6078..871d595 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,9 @@
- - markitecture Logo + Markitecture Logo

Markitecture

@@ -12,7 +11,7 @@ The Architecture of Better Documentation.

- Markdown tools for modular workflows and content management. + Tools for modular Markdown workflows and content management.

@@ -27,9 +26,11 @@ The Architecture of Better Documentation. PyPI Version - + + --> MIT License @@ -215,30 +216,32 @@ Contributions are welcome! Whether it's bug reports, feature requests, or code c ## License +Copyright © 2024 - 2025 Markitecture All rights reserved.
+Released under the [MIT][mit-license] license. + Copyright © 2024-2025 [Markitecture][markitecture].
Released under the [MIT][mit-license] license.
-[![][back-to-top]](#top) +[![][return-to-top]](#top)
- -
- separator + Thematic Break
- -[back-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-7934C5?style=flat-square +[return-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-7934C5?style=flat-square [pypi]: https://pypi.org/project/markitecture/ diff --git a/docs/assets/line.svg b/docs/assets/line.svg index d19448d..5efe92a 100644 --- a/docs/assets/line.svg +++ b/docs/assets/line.svg @@ -1,10 +1,10 @@ - - - - + + + + diff --git a/docs/assets/logo.svg b/docs/assets/logo.svg index b4e72af..385b97d 100644 --- a/docs/assets/logo.svg +++ b/docs/assets/logo.svg @@ -37,43 +37,4 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/docs/assets/shield.svg b/docs/assets/shield.svg index f38dd35..48e9088 100644 --- a/docs/assets/shield.svg +++ b/docs/assets/shield.svg @@ -2,10 +2,10 @@ - - - - + + + + diff --git a/notebooks/.gtikeep b/notebooks/.gtikeep new file mode 100644 index 0000000..e69de29