{"id":24769433,"url":"https://github.com/eli64s/markitecture","last_synced_at":"2025-10-11T19:30:53.353Z","repository":{"id":269705513,"uuid":"811697208","full_name":"eli64s/markitecture","owner":"eli64s","description":"❂ Tools for modular and flexible Markdown docs: link validation, reference-style link converter, text splitting, static site generation, \u0026 more.","archived":false,"fork":false,"pushed_at":"2025-01-24T07:40:52.000Z","size":352,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-24T08:28:12.560Z","etag":null,"topics":["ai","content-management","devtools","docs","documentation","documentation-tool","link-checker","link-validator","markdown","markdown-parser","markdown-split","markdown-tools","mkdocs","python","reference-links","reflinks"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/eli64s.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-06-07T05:55:38.000Z","updated_at":"2025-01-24T07:40:56.000Z","dependencies_parsed_at":null,"dependency_job_id":"2fcd1045-6ee2-4ee8-bf48-398641301d0e","html_url":"https://github.com/eli64s/markitecture","commit_stats":null,"previous_names":["eli64s/splitme-ai","eli64s/splitme","eli64s/markitecture"],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eli64s%2Fmarkitecture","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eli64s%2Fmarkitecture/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eli64s%2Fmarkitecture/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/eli64s%2Fmarkitecture/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/eli64s","download_url":"https://codeload.github.com/eli64s/markitecture/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":236122007,"owners_count":19098257,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ai","content-management","devtools","docs","documentation","documentation-tool","link-checker","link-validator","markdown","markdown-parser","markdown-split","markdown-tools","mkdocs","python","reference-links","reflinks"],"created_at":"2025-01-29T02:53:43.309Z","updated_at":"2025-10-11T19:30:53.347Z","avatar_url":"https://github.com/eli64s.png","language":"Python","readme":"\u003cdiv align=\"center\" id=\"top\"\u003e\n\n\u003cpicture\u003e\n  \u003csource media=\"(prefers-color-scheme: dark)\" srcset=\"[/assets/logo.svg](https://raw.githubusercontent.com/eli64s/markitecture/feb377343f7763e55143268f13de5dcb30934d29/docs/assets/logo.svg)\"\u003e\n  \u003csource media=\"(prefers-color-scheme: light)\" srcset=\"https://raw.githubusercontent.com/eli64s/markitecture/feb377343f7763e55143268f13de5dcb30934d29/docs/assets/logo.svg\"\u003e\n  \u003cimg alt=\"Markitecture Logo\" src=\"[/assets/logo.svg](https://raw.githubusercontent.com/eli64s/markitecture/feb377343f7763e55143268f13de5dcb30934d29/docs/assets/logo.svg)\" width=\"20%\" style=\"max-width: 100%;\"\u003e\n\u003c/picture\u003e\n\n\u003ch1\u003eMarkitecture\u003c/h1\u003e\n\nThe Architecture of Better Documentation.\n\n\u003cp align=\"center\"\u003e\n  \u003cem\u003eTools for modular Markdown workflows and content management.\u003c/em\u003e\n\u003c/p\u003e\n\n\u003c!-- SHIELD GROUP --\u003e\n\u003cdiv align=\"center\"\u003e\n  \u003cp align=\"center\" style=\"margin-bottom: 20px;\"\u003e\n    \u003ca href=\"https://github.com/eli64s/markitecture/actions\"\u003e\n      \u003cimg src=\"https://img.shields.io/github/actions/workflow/status/eli64s/markitecture/ci.yml?label=CI\u0026style=flat\u0026logo=githubactions\u0026logoColor=white\u0026labelColor=2A2A2A\u0026color=FFD700\" alt=\"GitHub Actions\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://app.codecov.io/gh/eli64s/markitecture\"\u003e\n      \u003cimg src=\"https://img.shields.io/codecov/c/github/eli64s/markitecture?label=Coverage\u0026style=flat\u0026logo=codecov\u0026logoColor=white\u0026labelColor=2A2A2A\u0026color=00E5FF\" alt=\"Coverage\" /\u003e\n    \u003c/a\u003e\n    \u003ca href=\"https://pypi.org/project/markitecture/\"\u003e\n      \u003cimg src=\"https://img.shields.io/pypi/v/markitecture?label=PyPI\u0026style=flat\u0026logo=pypi\u0026logoColor=white\u0026labelColor=2A2A2A\u0026color=7934C5\" alt=\"PyPI Version\" /\u003e\n    \u003c/a\u003e\n    \u003c!--\n    \u003ca href=\"https://github.com/eli64s/markitecture\"\u003e\n      \u003cimg src=\"https://img.shields.io/pypi/pyversions/markitecture?label=Python\u0026style=flat\u0026logo=python\u0026logoColor=white\u0026labelColor=2A2A2A\u0026color=7934C5\" alt=\"Python Version\" /\u003e\n    \u003c/a\u003e\n    --\u003e\n    \u003ca href=\"https://opensource.org/license/mit/\"\u003e\n      \u003cimg src=\"https://img.shields.io/github/license/eli64s/markitecture?label=License\u0026style=flat\u0026logo=opensourceinitiative\u0026logoColor=white\u0026labelColor=2A2A2A\u0026color=FF00FF\" alt=\"MIT License\"\u003e\n    \u003c/a\u003e\n  \u003c/p\u003e\n\u003c/div\u003e\n\n[Documentation][markitecture] · [Contribute][contributing] · [Report Bug][github-issues] · [Request Feature][github-issues]\n\n\u003c!--\n\u003cdetails\u003e\n\u003csummary\u003e\u003ckbd\u003eTable of Contents\u003c/kbd\u003e\u003c/summary\u003e\n\n- [Installation](#installation)\n- [Usage](#using-the-cli)\n- [Contributing](#contributing)\n- [License](#license)\n\n\u003c/details\u003e\n--\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg src=\"https://raw.githubusercontent.com/eli64s/markitecture/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/line.svg\" alt=\"separator\" width=\"100%\" height=\"2px\" style=\"margin: 20px 0;\"\u003e\n\u003c/div\u003e\n\n\u003c/div\u003e\n\n## What is Markitecture?\n\n**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.\n\n### Key Features\n\n- **Text Splitting:** Break down large Markdown files into manageable sections based on headings or custom rules.\n- **Link Management:** Convert between inline and reference-style links, validate URLs, and identify broken links.\n- **Content Analysis:** Analyze document structure, extract metadata, and ensure consistent formatting.\n- **Documentation Tools:** Generate configurations for static site generators like [MkDocs][mkdocs].\n\n---\n\n## Quick Start\n\n### Installation\n\nInstall from [PyPI][pypi] using your preferred package manager.\n\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/python.svg\"\u003e\u0026emsp13;pip\n\nUse [pip][pip] (recommended for most users):\n\n```sh\npip install -U markitecture\n```\n\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/pipx.svg\"\u003e\u0026emsp13;pipx\n\nInstall in an isolated environment with [pipx][pipx]:\n\n```sh\n❯ pipx install markitecture\n```\n\n#### \u003cimg width=\"2%\" src=\"https://simpleicons.org/icons/uv.svg\"\u003e\u0026emsp13;uv\n\nFor the fastest installation use [uv][uv]:\n\n```sh\n❯ uv tool install markitecture\n```\n\n### Using the CLI\n\n#### Text Splitting\n\nSplit large Markdown files into smaller, organized sections:\n\n```sh\nmarkitect \\\n    --split.i tests/data/readme-ai.md \\\n    --split.o examples/split-sections-h2\n```\n\n#### Link Validation\n\nCheck for broken links in your documentation:\n\n```sh\nmarkitect --check-links.input tests/data/pydantic.md\n```\n\nIn your terminal, you'll see a summary of the results:\n\n```console\n\nMarkdown Link Check Results\n\n┏━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━━━┓\n┃ Status ┃ Line ┃ Link                                                                              ┃ Error    ┃\n┡━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━━━┩\n│ ✓      │ 2    │ https://img.shields.io/github/actions/workflow/status/pydantic/pydantic/ci.yml?b… │          │\n│ ✓      │ 3    │ https://coverage-badge.samuelcolvin.workers.dev/pydantic/pydantic.svg             │          │\n│ ✓      │ 4    │ https://img.shields.io/pypi/v/pydantic.svg                                        │          │\n│ ✓      │ 5    │ https://img.shields.io/conda/v/conda-forge/pydantic.svg                           │          │\n│ ✓      │ 6    │ https://static.pepy.tech/badge/pydantic/month                                     │          │\n│ ✓      │ 7    │ https://img.shields.io/pypi/pyversions/pydantic.svg                               │          │\n│ ✓      │ 8    │ https://img.shields.io/github/license/pydantic/pydantic.svg                       │          │\n│ ✓      │ 9    │ https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/pydantic/p… │          │\n│ ✓      │ 18   │ https://pydantic.dev/articles/logfire-announcement                                │          │\n│ ✓      │ 24   │ https://docs.pydantic.dev/                                                        │          │\n│ ✓      │ 24   │ https://github.com/pydantic/pydantic/tree/1.10.X-fixes                            │          │\n│ ✓      │ 28   │ https://docs.pydantic.dev/                                                        │          │\n│ 𝗫      │ 34   │ https://docs.pydantic.dev/install/invalid-link                                    │ HTTP 404 │\n└────────┴──────┴───────────────────────────────────────────────────────────────────────────────────┴──────────┘\n\nSummary: 1 broken links out of 13 total links.\n```\n\n#### Reference Link Conversion\n\nIn Markdown, [reference-style links][reflinks] let you write cleaner text by keeping URLs in a reference section - think footnotes for the web.\n\nTo convert inline links to reference-style links:\n\n```sh\nmarkitect \\\n    --reflinks.input tests/data/pydantic.md \\\n    --reflinks.output with_refs.md\n```\n\n#### Static Site Configuration Generation\n\nGenerate a MkDocs configuration [(mkdocs.yml)][mkdocs.yml] from a given Markdown file.\n\n1. Split the Markdown file into sections:\n\n    ```sh\n    markitect \\\n        --split.i tests/data/readme-ai.md \\\n        --split.o examples/split-sections-h2\n    ```\n\n2. Generate the MkDocs configuration:\n\n    ```sh\n    markitect \\\n        --mkdocs.dir examples/split-sections-h2 \\\n        --mkdocs.site-name \"MyDocsSite\"\n    ```\n\n\u003csub\u003e\n\nSee additional example and usage details in the [here][examples].\n\n\u003c/sub\u003e\n\n\u003c!--\n\u003e[!NOTE]\n\u003e Explore the [Official Documentation][docs] for more detailed guides and examples.\n--\u003e\n\n---\n\n## Roadmap\n\n- [ ] Support for additional documentation formats (e.g., reStructuredText, HTML)\n- [ ] Enhanced link management utilities\n- [ ] Improved content analysis features\n- [ ] Integration with more static site generators\n- [ ] Plugin system for custom utilities\n- [ ] More intuitive CLI commands and options\n\n---\n\n## Contributing\n\nContributions are welcome! Whether it's bug reports, feature requests, or code contributions, please feel free to:\n\n- Open an [issue][github-issues]\n- Submit a [pull request][github-pulls]\n- Improve documentation, write tutorials, etc.\n- Share your feedback and suggestions\n\n---\n\n## License\n\nCopyright \u0026copy; 2024-2025 [Markitecture][markitecture]. \u003cbr /\u003e\nReleased under the [MIT][mit-license] license.\n\n\u003cdiv align=\"left\"\u003e\n\n[![][return-to-top]](#top)\n\n\u003c/div\u003e\n\n\u003cdiv align=\"center\"\u003e\n  \u003cimg\n  src=\"https://raw.githubusercontent.com/eli64s/markitecture/216a92894e6f30c707a214fad5a5fba417e3bc39/docs/assets/line.svg\"\n  alt=\"Thematic Break\"\n  width=\"100%\"\n  height=\"2px\"\n  style=\"margin: 20px 0;\"\n  \u003e\n\u003c/div\u003e\n\n\u003c!-- REFERENCE LINKS --\u003e\n\n\u003c!-- BADGES --\u003e\n[return-to-top]: https://img.shields.io/badge/-BACK_TO_TOP-7934C5?style=flat-square\n\n\u003c!-- PROJECT RESOURCES --\u003e\n[pypi]: https://pypi.org/project/markitecture/\n[markitecture]: https://github.com/eli64s/markitecture\n[github-issues]: https://github.com/eli64s/markitecture/issues\n[github-pulls]: https://github.com/eli64s/markitecture/pulls\n[contributing]: https://github.com/eli64s/markitecture/blob/main/CONTRIBUTING.md\n[mit-license]: https://github.com/eli64s/markitecture/blob/main/LICENSE\n[examples]: https://github.com/eli64s/markitecture/tree/main/examples\n\n\u003c!-- DEVELOPER TOOLS --\u003e\n[python]: https://www.python.org/\n[pip]: https://pip.pypa.io/en/stable/\n[pipx]: https://pipx.pypa.io/stable/\n[uv]: https://docs.astral.sh/uv/\n[mkdocs]: https://www.mkdocs.org/\n[mkdocs.yml]: https://www.mkdocs.org/user-guide/configuration/\n\n\u003c!-- RESOURCES --\u003e\n[reflinks]: https://www.markdownguide.org/basic-syntax/#reference-style-links\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feli64s%2Fmarkitecture","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Feli64s%2Fmarkitecture","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Feli64s%2Fmarkitecture/lists"}