markitecture 0.1.15__tar.gz

markitecture-0.1.15/.gitignore

@@ -0,0 +1,41 @@
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+.env
+.venv
+env/
+venv/
+ENV/
+.idea/
+.vscode/
+*.swp
+.DS_Store
+.mypy_cache/
+.pytest_cache/
+.ruff_cache/
+.reports/
+site/
+.continuerules
+
+# -- Markitect ---------
+markitect.yml
+.markitecture/
+notebooks/

markitecture-0.1.15/.ruff.toml

@@ -0,0 +1,63 @@
+exclude = [
+    ".env,",
+    ".git",
+    ".ipynb_checkpoints",
+    ".mypy_cache",
+    ".nox",
+    ".pyenv",
+    ".pytest_cache",
+    ".ruff_cache",
+    "venv",
+    ".venv",
+    ".vscode",
+]
+line-length = 88
+indent-width = 4
+target-version = "py311"
+
+[lint]
+preview = true
+extend-select = [
+    "E305",     # 2 blank lines before class or function
+]
+select = [
+    "ARG",      # unused arguments
+    "B",        # flake8-bugbear
+    "E",        # pycodestyle
+    "E303",     # too many blank lines
+    "E722",     # bare except statements
+    "F",        # pyflakes
+    "F401",     # remove unused imports
+    "I",        # isort
+    "N",        # pep8-naming
+    "RUF",      # ruff
+    "SIM",      # flake8-simplify
+    "UP",       # pyupgrade
+    "W",        # pycodestyle
+    "W291",     # trailing whitespace
+    "W293",     # blank line contains whitespace
+    "F821",     # undefined name
+]
+fixable = ["ALL"]
+ignore = [
+    "UP006",
+    "UP007",
+    "UP035",
+]
+unfixable = []
+
+[lint.isort]
+known-third-party = ["readmeai"]
+relative-imports-order = "closest-to-furthest"
+split-on-trailing-comma=true
+
+[lint.pydocstyle]
+convention = "numpy"
+
+[format]
+docstring-code-format = true
+docstring-code-line-length = 88
+indent-style = "space"
+line-ending = "auto"
+preview = true
+quote-style = "double"

markitecture-0.1.15/CONTRIBUTING.md

@@ -0,0 +1,123 @@
+# Contributing to Markitecture
+
+👋 Welcome, thank you for considering contributing to Markitecture! Happy to have you join our community. Every contribution, no matter how small, helps make Markitecture better for everyone.
+
+This document outlines how to contribute to the project and the standards we follow. Please take a few moments to read through it before submitting your first contribution.
+
+## How You Can Contribute
+
+There are many ways you can contribute to Markitecture:
+
+*   **🐛 Report Bugs:** Found a bug? Let us know by opening a [new issue][issues]. Please provide a clear description of the issue, including steps to reproduce it, your operating system, Python version, and Markitecture version.
+*   **✨ Suggest Enhancements:** Have an idea for a new feature or improvement? We'd love to hear it! Open a [new issue][issues] and describe your suggestion.
+*   **📖 Improve Documentation:** Help us make the documentation clearer, more comprehensive, or more accurate.
+*   **🛠️ Contribute Code:** Contribute new features, fix bugs, or improve existing code.
+*   **📣 Spread the Word:** Share Markitecture with others who might find it useful!
+
+## Getting Started
+
+Here's how to get started with contributing code or documentation:
+
+1.  **Fork the Repository:** Start by forking the [Markitecture repository][markitecture] on GitHub (or your chosen platform).
+
+2.  **Clone Your Fork:** Clone your forked repository to your local machine:
+
+    ```bash
+    git clone https://github.com/eli64s/markitecture.git
+    cd markitecture
+    ```
+
+3.  **Create a Branch:** Create a new branch for your changes:
+
+    ```bash
+    git checkout -b feature/your-feature-name
+    ```
+
+    Use a descriptive branch name that reflects your changes (e.g., `bugfix/link-validation-edge-case`, `feature/new-feature`, `docs/update-readme`). This will help you and others easily identify the purpose of the branch.
+
+4.  **Set Up Your Development Environment:**
+
+    Follow these steps to get a development version of Markitecture up and running:
+
+    1.  **Create a virtual environment:**
+
+        ```bash
+        make venv
+        ```
+
+    2.  **Install project dependencies:**
+
+        ```bash
+        make install
+        make lock
+        ```
+
+    3.  **Install pre-commit hooks:**
+
+        ```bash
+        pre-commit install
+        ```
+
+5.  **Make Your Changes:** Implement your bug fix, feature, or documentation update.
+
+6.  **Test Your Changes:** Ensure your changes don't break existing functionality by running the tests:
+
+    ```bash
+    make test
+    ```
+
+7.  **Commit Your Changes:** Commit your changes with clear and concise commit messages:
+
+    ```bash
+    git commit -m "fix: Resolved issue with link validation"
+    ```
+
+8.  **Push to Your Fork:** Push your branch to your forked repository:
+
+    ```bash
+    git push origin feature/your-feature-name
+    ```
+
+9.  **Open a Pull Request:** Go to the original Markitecture repository and open a pull request from your branch. Provide a clear description of your changes in the pull request.
+
+## Code Style and Standards
+
+*   We adhere to the [PEP 8](https://www.python.org/dev/peps/pep-0008/) style guide for Python code.
+*   We use `ruff` for code formatting and linting. You can run it locally before committing:
+
+    ```bash
+    make format-and-lint
+    ```
+*   Add tests for any new features or bug fixes.
+*   Document any new or changed functionality in the code using docstrings and, if necessary, update the user-facing documentation.
+*   Keep your code clean, well-commented, and easy to understand.
+
+## Code of Conduct
+
+We expect all contributors to follow our [Code of Conduct]([link to your Code of Conduct - e.g., CODE_OF_CONDUCT.md]). Please be respectful and considerate of others in all your interactions within the project.
+
+## Pull Request Process
+
+1.  We'll review your pull request as soon as possible.
+2.  We may suggest changes or improvements. We encourage open feedback and collaboration.
+3.  Once your pull request is approved, it will be merged into the `main` branch.
+
+## Questions and Support
+
+If you have any questions or need help with contributing, please don't hesitate to:
+
+*   Open an [issue][issues] in the project's issue tracker.
+*   Join our [discussion forum][discussions] and ask your question there.
+
+We appreciate your contributions and look forward to collaborating with you!
+
+---
+
+**Cheers!**
+
+The Markitecture Team
+
+<!-- REFERENCE LINKS -->
+[discussions]: https://github.com/eli64s/markitecture/discussions
+[issues]: https://github.com/eli64s/markitecture/issues
+[markitecture]: https://github.com/eli64s/markitecture/

markitecture-0.1.15/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 to present Markitecture and individual contributors.
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+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.

markitecture-0.1.15/Makefile

@@ -0,0 +1,171 @@
+SHELL := /bin/bash
+.ONESHELL:
+.SHELLFLAGS := -eu -o pipefail -c
+.DELETE_ON_ERROR:
+MAKEFLAGS += --warn-undefined-variables
+MAKEFLAGS += --no-builtin-rules
+
+DOCS_DIR := docs
+PYPROJECT_TOML := pyproject.toml
+PYPI_VERSION := 0.1.15
+PYTHON_VERSION := 3.11
+TARGET := src/markitecture
+TARGET_TEST := tests
+TEST_DATA := tests/data/readme-ai.md
+
+
+# -------------------------------------------------------------------
+# Build: Build the distribution package using uv
+# -------------------------------------------------------------------
+
+
+.PHONY: build
+build: ## Build the distribution package using uv
+	uv build
+	uv pip install dist/markitecture-$(PYPI_VERSION)-py3-none-any.whl
+
+.PHONY: install
+install: ## Install all dependencies from pyproject.toml
+	uv sync --dev --group lint --group test --all-extras
+
+.PHONY: lock
+lock: ## Lock dependencies declared in pyproject.toml
+	uv pip compile $(PYPROJECT_TOML) --all-extras
+
+.PHONY: requirements
+requirements: ## Generate requirements files from pyproject.toml
+	uv pip compile $(PYPROJECT_TOML) -o requirements.txtiu
+	uv pip compile $(PYPROJECT_TOML) --all-extras -o requirements-dev.txt
+
+.PHONY: sync
+sync: ## Sync environment with pyproject.toml
+	uv sync --all-groups --dev
+
+.PHONY: update
+update: ## Update all dependencies from pyproject.toml
+	uv lock --upgrade
+
+.PHONY: venv
+venv: ## Create a virtual environment
+	uv venv --python $(PYTHON_VERSION)
+
+
+# -------------------------------------------------------------------
+# Documenation: Build and serve static site using MkDocs
+# -------------------------------------------------------------------
+
+.PHONY: docs
+docs: ## Serve mintlify documentation locally
+	cd $(DOCS_DIR) && npx mintlify dev --verbose
+
+
+# -------------------------------------------------------------------
+# Format & Lint: Format and lint Python files using Ruff and MyPy
+# -------------------------------------------------------------------
+
+
+.PHONY: format-toml
+format-toml: ## Format TOML files using pyproject-fmt
+	uvx --isolated pyproject-fmt $(TOML_FILE) --indent 4
+
+.PHONY: format
+format: ## Format Python files using Ruff
+	@echo -e "\n► Running the Ruff formatter..."
+	uvx --isolated ruff format $(TARGET)
+
+.PHONY: lint
+lint: ## Lint Python files using Ruff
+	@echo -e "\n ►Running the Ruff linter..."
+	uvx --isolated ruff check $(TARGET) --fix
+
+.PHONY: format-and-lint
+format-and-lint: format lint ## Format and lint Python files
+
+.PHONY: typecheck-mypy
+typecheck-mypy: ## Type-check Python files using MyPy
+	uv run mypy $(TARGET)
+
+.PHONY: typecheck-pyright
+typecheck-pyright: ## Type-check Python files using Pyright
+	uv run pyright $(TARGET)
+
+
+# -------------------------------------------------------------------
+# Tests: Run test suite using Pytest
+# -------------------------------------------------------------------
+
+
+.PHONY: test
+test: ## Run test suite using Pytest
+	uv run pytest $(TARGET_TEST) --config-file $(PYPROJECT_TOML)
+
+
+# -------------------------------------------------------------------
+# Examples: Batch run CLI examples for documentation and testing
+# -------------------------------------------------------------------
+
+
+.PHONY: run-examples
+run-examples: ## Run examples for documentation and testing
+	@echo -e "\n► Running split commands..."
+	uv run markitect --split.i $(TEST_DATA) --split.o examples/text-splitter/header-2 --split.level "##"
+	@echo -e "\n--------------------------------------------------------------------------------\n"
+	uv run markitect --split.i $(TEST_DATA) --split.o examples/text-splitter/header-3/ --split.level "###"
+	@echo -e "\n--------------------------------------------------------------------------------\n"
+	uv run markitect --split.i $(TEST_DATA) --split.o examples/text-splitter/header-4/ --split.level "####"
+	@echo -e "\n--------------------------------------------------------------------------------\n"
+	uv run markitect --reflinks.i tests/data/pydantic.md --reflinks.o examples/reference-links/reflinks_conversion.md
+	@echo -e "\n--------------------------------------------------------------------------------\n"
+	@echo -e "\n► Checking for markdown files in examples/text-splitter/header-2..."
+	@if [ -z "$$(find examples/text-splitter/header-2 -maxdepth 1 -type f -name '*.md')" ]; then \
+	  echo "Warning: No markdown files found in examples/text-splitter/header-2. Skipping MkDocs config generation."; \
+	else \
+	  echo "Generating MkDocs static site config for: examples/text-splitter/header-2"; \
+	  uv run markitect --metrics.input $(TEST_DATA) --metrics.style all --metrics.output-dir examples/metrics; \
+	fi
+	@echo -e "\n--------------------------------------------------------------------------------\n"
+
+.PHONY: run-pypi
+run-pypi: ## Run examples for documentation
+	uvx --isolated markitect --split.i $(TEST_DATA) --split.o examples/text-splitter/pypi/header-2/ --split.level "##"
+	uvx --isolated markitect --split.i $(TEST_DATA) --split.o examples/text-splitter/pypi/header-3/ --split.level "###"
+	uvx --isolated markitect --split.i $(TEST_DATA) --split.o examples/text-splitter/pypi/header-4/ --split.level "####"
+	uvx --isolated markitect --reflinks.i tests/data/pydantic.md --reflinks.o examples/reference-links/reflinks_conversion.md
+
+
+# -------------------------------------------------------------------
+# Utils: Utility commands for managing the project
+# -------------------------------------------------------------------
+
+
+clean: clean-build clean-pyc clean-test ## remove all build, test, coverage and Python artifacts
+
+clean-build: ## remove build artifacts
+	rm -fr build/
+	rm -fr dist/
+	rm -fr .eggs/
+	rm -fr .venv/
+	find . -name '*.egg-info' -exec rm -fr {} +
+	find . -name '*.egg' -exec rm -f {} +
+
+clean-pyc: ## remove Python file artifacts
+	find . -name '*.pyc' -exec rm -f {} +
+	find . -name '*.pyo' -exec rm -f {} +
+	find . -name '*~' -exec rm -f {} +
+	find . -name '__pycache__' -exec rm -fr {} +
+
+clean-test: ## remove test and coverage artifacts
+	rm -fr .tox/
+	rm -f .coverage
+	rm -fr htmlcov/
+	rm -fr .pytest_cache
+
+.PHONY: help
+help: ## Display this help
+	@echo ""
+	@echo "Usage: make [target]"
+	@echo ""
+	@awk 'BEGIN {FS = ":.*?## "; printf "\033[1m%-20s %-50s\033[0m\n", "Target", "Description"; \
+	              printf "%-20s %-50s\n", "------", "-----------";} \
+	      /^[a-zA-Z_-]+:.*?## / {printf "\033[36m%-20s\033[0m %-50s\n", $$1, $$2}' $(MAKEFILE_LIST)
+	@echo ""

markitecture-0.1.15/PKG-INFO

@@ -0,0 +1,271 @@
+Metadata-Version: 2.4
+Name: markitecture
+Version: 0.1.15
+Summary: ❂ Markdown tools for modular and flexible docs: link validation, reference link conversion, text splitting, & more.
+Project-URL: documentation, https://github.com/eli64s/markitecture/blob/main/README.md
+Project-URL: homepage, https://github.com/eli64s/markitecture
+Project-URL: repository, https://github.com/eli64s/markitecture
+Author-email: Eli Salamie <egsalamie@gmail.com>
+License-Expression: MIT
+License-File: LICENSE
+Keywords: automated-markdown,content-management,documentation-tools,intelligent-documentation,markdown-ai,markdown-link-checker,markdown-parser,markdown-splitter,markdown-tools,mkdocs,modular-docs,readme-generator,reference-links,smart-markdown
+Classifier: Development Status :: 3 - Alpha
+Classifier: Framework :: Pydantic
+Classifier: Framework :: Pytest
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Documentation
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Typing :: Typed
+Requires-Python: <=3.14,>=3.10
+Requires-Dist: httpx
+Requires-Dist: pydantic
+Requires-Dist: pydantic-settings
+Requires-Dist: pyyaml
+Requires-Dist: rich
+Requires-Dist: toml; python_full_version < '3.11'
+Description-Content-Type: text/markdown
+
+<div id="top" align="center">
+
+<!-- HEADER -->
+<picture>
+  <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/eli64s/markitecture/13c4b28213fb8e8c75299ef5c905ce1d195a6988/docs/assets/logos/circle-dark.svg">
+  <source media="(prefers-color-scheme: light)" srcset="https://raw.githubusercontent.com/eli64s/markitecture/13c4b28213fb8e8c75299ef5c905ce1d195a6988/docs/assets/logos/circle-light.svg">
+  <img alt="markitecture Logo" src="https://raw.githubusercontent.com/eli64s/markitecture/13c4b28213fb8e8c75299ef5c905ce1d195a6988/docs/assets/logos/circle-light.svg" width="900" style="max-width: 100%;">
+</picture>
+
+<h3 align="center">
+   Building Blocks for Brilliant Documentation.
+</h3>
+<p align="center">
+  <em>Markitecture: The Python toolkit that empowers modular Markdown workflows.</em>
+</p>
+
+<!-- BADGES -->
+<div align="center">
+  <p align="center" style="margin-bottom: 20px;">
+    <a href="https://github.com/eli64s/markitecture/actions">
+      <img src="https://img.shields.io/github/actions/workflow/status/eli64s/markitecture/ci.yml?label=CI&style=flat&logo=githubactions&logoColor=white&labelColor=2A2A2A&color=FFD700" alt="GitHub Actions" />
+    </a>
+    <a href="https://app.codecov.io/gh/eli64s/markitecture">
+      <img src="https://img.shields.io/codecov/c/github/eli64s/markitecture?label=Coverage&style=flat&logo=codecov&logoColor=white&labelColor=2A2A2A&color=3fe1c0" alt="Coverage" />
+    </a>
+    <a href="https://pypi.org/project/markitecture/">
+      <img src="https://img.shields.io/pypi/v/markitecture?label=PyPI&style=flat&logo=pypi&logoColor=white&labelColor=2A2A2A&color=00E5FF" alt="PyPI Version" />
+    </a>
+    <a href="https://github.com/eli64s/markitecture">
+      <img src="https://img.shields.io/pypi/pyversions/markitecture?label=Python&style=flat&logo=python&logoColor=white&labelColor=2A2A2A&color=7934C5" alt="Python Version" />
+    </a>
+    <a href="https://opensource.org/license/mit/">
+      <img src="https://img.shields.io/github/license/eli64s/markitecture?label=License&style=flat&logo=opensourceinitiative&logoColor=white&labelColor=2A2A2A&color=FF00FF" alt="MIT License">
+    </a>
+  </p>
+</div>
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/eli64s/markitecture/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/line.svg" alt="separator" width="100%" height="2px" style="margin: 20px 0;">
+</div>
+
+</div>
+<!-- HEADER END -->
+
+## What is Markitecture?
+
+**Markitecture** is a comprehensive Python toolkit designed to streamline your Markdown workflow. Whether you're managing documentation, writing technical content, or maintaining a knowledge base, Markitecture provides essential utilities to make working with Markdown files easier and more efficient.
+
+### Key Features
+
+- **Text Splitting:** Break down large Markdown files into manageable sections based on headings or custom rules.
+- **Link Management:** Convert between inline and reference-style links, validate URLs, and identify broken links.
+- **Content Analysis:** Analyze document structure, extract metadata, and ensure consistent formatting.
+- **Documentation Tools:** Generate configurations for static site generators like [MkDocs][mkdocs].
+
+---
+
+## Quick Start
+
+### Installation
+
+Install from [PyPI][pypi] using your preferred package manager.
+
+#### <img width="2%" src="https://simpleicons.org/icons/python.svg">&emsp13;pip
+
+Use [pip][pip] (recommended for most users):
+
+```sh
+pip install -U markitecture
+```
+
+#### <img width="2%" src="https://simpleicons.org/icons/pipx.svg">&emsp13;pipx
+
+Install in an isolated environment with [pipx][pipx]:
+
+```sh
+❯ pipx install markitecture
+```
+
+#### <img width="2%" src="https://simpleicons.org/icons/uv.svg">&emsp13;uv
+
+For the fastest installation use [uv][uv]:
+
+```sh
+❯ uv tool install markitecture
+```
+
+### Using the CLI
+
+#### Text Splitting
+
+Split large Markdown files into smaller, organized sections:
+
+```sh
+markitect \
+    --split.i tests/data/readme-ai.md \
+    --split.o examples/split-sections-h2
+```
+
+#### Link Validation
+
+Check for broken links in your documentation:
+
+```sh
+markitect --check-links.input tests/data/pydantic.md
+```
+
+In your terminal, you'll see a summary of the results:
+
+```console
+
+Markdown Link Check Results
+
+┏━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓
+┃ Status ┃ Line ┃ Link                                                                              ┃ Error    ┃
+┡━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩
+│ ✓      │ 2    │ https://img.shields.io/github/actions/workflow/status/pydantic/pydantic/ci.yml?b… │          │
+│ ✓      │ 3    │ https://coverage-badge.samuelcolvin.workers.dev/pydantic/pydantic.svg             │          │
+│ ✓      │ 4    │ https://img.shields.io/pypi/v/pydantic.svg                                        │          │
+│ ✓      │ 5    │ https://img.shields.io/conda/v/conda-forge/pydantic.svg                           │          │
+│ ✓      │ 6    │ https://static.pepy.tech/badge/pydantic/month                                     │          │
+│ ✓      │ 7    │ https://img.shields.io/pypi/pyversions/pydantic.svg                               │          │
+│ ✓      │ 8    │ https://img.shields.io/github/license/pydantic/pydantic.svg                       │          │
+│ ✓      │ 9    │ https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/p… │          │
+│ ✓      │ 18   │ https://pydantic.dev/articles/logfire-announcement                                │          │
+│ ✓      │ 24   │ https://docs.pydantic.dev/                                                        │          │
+│ ✓      │ 24   │ https://github.com/pydantic/pydantic/tree/1.10.X-fixes                            │          │
+│ ✓      │ 28   │ https://docs.pydantic.dev/                                                        │          │
+│ 𝗫      │ 34   │ https://docs.pydantic.dev/install/invalid-link                                    │ HTTP 404 │
+└────────┴──────┴───────────────────────────────────────────────────────────────────────────────────┴──────────┘
+
+Summary: 1 broken links out of 13 total links.
+```
+
+#### Reference Link Conversion
+
+In Markdown, [reference-style links][reflinks] let you write cleaner text by keeping URLs in a reference section - think footnotes for the web.
+
+To convert inline links to reference-style links:
+
+```sh
+markitect \
+    --reflinks.input tests/data/pydantic.md \
+    --reflinks.output with_refs.md
+```
+
+#### Static Site Configuration Generation
+
+Generate a MkDocs configuration [(mkdocs.yml)][mkdocs.yml] from a given Markdown file.
+
+1. Split the Markdown file into sections:
+
+    ```sh
+    markitect \
+        --split.i tests/data/readme-ai.md \
+        --split.o examples/split-sections-h2
+    ```
+
+2. Generate the MkDocs configuration:
+
+    ```sh
+    markitect \
+        --mkdocs.dir examples/split-sections-h2 \
+        --mkdocs.site-name "MyDocsSite"
+    ```
+
+<sub>
+
+See additional example and usage details in the [here][examples].
+
+</sub>
+
+<!--
+>[!NOTE]
+> Explore the [Official Documentation][docs] for more detailed guides and examples.
+-->
+
+---
+
+## Roadmap
+
+- [ ] Support for additional documentation formats (e.g., reStructuredText, HTML)
+- [ ] Enhanced link management utilities
+- [ ] Improved content analysis features
+- [ ] Integration with more static site generators
+- [ ] Plugin system for custom utilities
+- [ ] More intuitive CLI commands and options
+
+---
+
+## Contributing
+
+Contributions are welcome! Whether it's bug reports, feature requests, or code contributions, please feel free to:
+
+- Open an [issue][github-issues]
+- Submit a [pull request][github-pulls]
+- Improve documentation, write tutorials, etc.
+- Share your feedback and suggestions
+
+---
+
+## License
+
+Copyright © 2024-2025 [Markitecture][markitecture]. <br />
+Released under the [MIT][mit-license] license.
+
+<div align="left">
+  <a href="#top">
+    <img src="https://raw.githubusercontent.com/eli64s/markitecture/77bec69129dd3a075d7d0816c7bd826da131ccc7/docs/assets/buttons/rectangle.svg" width="100px" height="100px" alt="Return to Top">
+  </a>
+</div>
+
+<div align="center">
+  <img src="https://raw.githubusercontent.com/eli64s/markitecture/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/line.svg" alt="separator" width="100%" height="2px" style="margin: 20px 0;">
+</div>
+
+
+<!-- REFERENCE LINKS -->
+
+<!-- PROJECT RESOURCES -->
+[pypi]: https://pypi.org/project/markitecture/
+[markitecture]: https://github.com/eli64s/markitecture
+[github-issues]: https://github.com/eli64s/markitecture/issues
+[github-pulls]: https://github.com/eli64s/markitecture/pulls
+[mit-license]: https://github.com/eli64s/markitecture/blob/main/LICENSE
+[examples]: https://github.com/eli64s/markitecture/tree/main/examples
+
+<!-- DEVELOPER TOOLS -->
+[python]: https://www.python.org/
+[pip]: https://pip.pypa.io/en/stable/
+[pipx]: https://pipx.pypa.io/stable/
+[uv]: https://docs.astral.sh/uv/
+[mkdocs]: https://www.mkdocs.org/
+[mkdocs.yml]: https://www.mkdocs.org/user-guide/configuration/
+
+<!-- RESOURCES -->
+[reflinks]: https://www.markdownguide.org/basic-syntax/#reference-style-links