{"id":31642503,"url":"https://github.com/tameronline/indexmd","last_synced_at":"2026-02-14T20:33:49.092Z","repository":{"id":320022779,"uuid":"1005342591","full_name":"TamerOnLine/indexMD","owner":"TamerOnLine","description":"📚 Auto-generate professional documentation from your README.md using MkDocs + CLI panel.","archived":false,"fork":false,"pushed_at":"2025-06-20T10:30:45.000Z","size":26202,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-10-21T14:50:24.750Z","etag":null,"topics":["cli","documentation","github-pages","markdown","mkdocs"],"latest_commit_sha":null,"homepage":"https://tameronline.github.io/indexMD/","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/TamerOnLine.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-06-20T04:48:18.000Z","updated_at":"2025-06-27T21:45:18.000Z","dependencies_parsed_at":null,"dependency_job_id":"89acc326-57ab-4537-9346-6eb53fb9dd26","html_url":"https://github.com/TamerOnLine/indexMD","commit_stats":null,"previous_names":["tameronline/indexmd"],"tags_count":1,"template":true,"template_full_name":"TamerOnLine/basec_indexMD","purl":"pkg:github/TamerOnLine/indexMD","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TamerOnLine%2FindexMD","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TamerOnLine%2FindexMD/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TamerOnLine%2FindexMD/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TamerOnLine%2FindexMD/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/TamerOnLine","download_url":"https://codeload.github.com/TamerOnLine/indexMD/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/TamerOnLine%2FindexMD/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":29455353,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-02-14T15:52:44.973Z","status":"ssl_error","status_checked_at":"2026-02-14T15:52:11.208Z","response_time":53,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.6:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["cli","documentation","github-pages","markdown","mkdocs"],"created_at":"2025-10-07T03:59:57.344Z","updated_at":"2026-02-14T20:33:49.062Z","avatar_url":"https://github.com/TamerOnLine.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# 📦 indexMD – Markdown-Based Documentation Generator\nA lightweight documentation generator powered by MkDocs and custom scripts to automate README-based documentation deployment.\n\n---\n\n[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](LICENSE)\n[![View Wiki](https://img.shields.io/badge/Wiki-Available-blue?logo=github)](https://github.com/TamerOnLine/indexMD/wiki/01.-Home)\n[![Docs](https://img.shields.io/badge/Docs-Available-brightgreen.svg)](./docs/)\n\n\n[![GitHub Stars](https://img.shields.io/github/stars/TamerOnLine/indexMD?style=social)](https://github.com/TamerOnLine/indexMD/stargazers)\n[![GitHub Forks](https://img.shields.io/github/forks/TamerOnLine/indexMD?style=social)](https://github.com/TamerOnLine/indexMD/fork)\n[![GitHub Issues](https://img.shields.io/github/issues/TamerOnLine/indexMD)](https://github.com/TamerOnLine/indexMD/issues)\n[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/TamerOnLine/indexMD)](https://github.com/TamerOnLine/indexMD/pulls)\n\n\n[![Python Version](https://img.shields.io/badge/Python-3.12-blue.svg)](https://www.python.org/downloads/release/python-3120/)\n[![MkDocs Version](https://img.shields.io/badge/MkDocs-1.5.3-blue.svg)](https://www.mkdocs.org/)\n[![Pip Version](https://img.shields.io/badge/Pip-23.2.1-blue.svg)](https://pypi.org/project/pip/)\n\n\n[![GitHub Actions](https://img.shields.io/badge/GitHub%20Actions-Enabled-blue.svg)](https://github.com/TamerOnLine/indexMD/actions)\n[![Code Quality](https://img.shields.io/badge/Code%20Quality-High-green.svg)](https://github.com/TamerOnLine/indexMD)\n[![Last Commit](https://img.shields.io/github/last-commit/TamerOnLine/indexMD)](https://github.com/TamerOnLine/indexMD/commits)\n[![Contributors](https://img.shields.io/github/contributors/TamerOnLine/indexMD)](https://github.com/TamerOnLine/indexMD/graphs/contributors)\n\n\n[![Built with ❤️ by Tamer](https://img.shields.io/badge/Built%20with-%E2%9D%A4%EF%B8%8F%20by%20Tamer-orange)](https://github.com/TamerOnLine)\n\n---\n\n📘 [Live Documentation](https://tameronline.github.io/indexMD/)\n\n---\n\n## 📖 Full Documentation – Wiki\n\nNeed step-by-step guides on installation, usage, customization, or contributions?  \nExplore the **official project Wiki** for complete technical documentation:\n\n➡️ [View the Wiki](https://github.com/TamerOnLine/indexMD/wiki/01.-Home)\n\n\u003e 👤 📝 Maintained and regularly updated for all user levels: beginners, contributors, and advanced users.\n\n---\n\n\u003cp align=\"center\"\u003e\n  \u003cimg src=\"screenshots/control-panel.gif\" alt=\"indexMD CLI Control Panel\" width=\"600\"/\u003e\n\u003c/p\u003e\n\n---\n\n## Table of Contents\n\n- [Features ✨](#features)\n- [Clone the Repository 📥](#clone-the-repository)\n- [Quick Start 🚀](#quick-start)\n- [Optional: Upgrade pip (recommended) ⬆️](#optional-upgrade-pip-recommended)\n- [Install Dependencies 📦](#install-dependencies)\n- [indexMD Control Panel 🎛️](#indexmd-control-panel)\n- [CLI Options Explained 🧩](#cli-options-explained)\n- [Project Structure 🧱](#project-structure)\n\n---\n\n## Features\n\n- 📄 **Markdown-based documentation**  \n- 📦 **MkDocs for static site generation**  \n- 📑 **Custom HTML overrides**  \n- 🌐 **Customizable themes and styles**  \n- 📖 **Multi-section support** (About, Contact, Privacy, Terms…)  \n- 🔗 **Important links section**\n\n\u003cbr\u003e\n\n[🔝 Back to Top](#table-of-contents)\n\n---\n\n## Clone the Repository\n\nTo get started, clone this repository to your local machine using Git:\n\n```bash\ngit clone https://github.com/TamerOnline/indexMD.git\ncd indexMD\n```\n\n- Make sure you have Git installed: [https://git-scm.com](https://git-scm.com)\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"screenshots/clone-the-repository.gif\"\u003e\n    \u003cimg src=\"screenshots/clone-the-repository.gif\" alt=\"Quick clone-the-repository\" width=\"600\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n📽️ Quick Clone of the indexMD repository in action\n\n\u003cbr\u003e\n\n[🔝 Back to Top](#table-of-contents)\n\n---\n\n## Quick Start\n\n### Create Virtual Environment\n\n```bash\n# Windows\npy -3.12 -m venv venv\n.\\venv\\Scripts\\Activate\n```\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"screenshots/Windows.gif\"\u003e\n  \u003cimg src=\"screenshots/Windows.gif\" alt=\"Encryption Service Tools Windows\" width=\"600\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n📽️ Quick setup of indexMD on Windows in action\n\n\u003cbr\u003e\n\n[🔝 Back to Top](#table-of-contents)\n\n---\n\n```bash\n# macOS / Linux\npython3 -m venv venv\nsource venv/bin/activate\n```\n\n---\n\n### Optional: Upgrade pip (recommended)\n\nBefore installing dependencies, it's recommended to upgrade `pip` to the latest version to avoid compatibility issues.\n\n```bash\npython -m pip install --upgrade pip\n```\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"screenshots/Upgrade_pip.gif\"\u003e\n  \u003cimg src=\"screenshots/Upgrade_pip.gif\" alt=\"Upgrade pip Tools Windows\" width=\"600\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n📽️ Upgrading pip on Windows (recommended)\n\n\u003cbr\u003e\n\n[🔝 Back to Top](#table-of-contents)\n\n---\n\n### Install Dependencies\n\n```bash\npip install -r requirements.txt\n```\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"screenshots/install.gif\"\u003e\n  \u003cimg src=\"screenshots/install.gif\" alt=\"index MD Tools install\" width=\"600\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n📽️ Quick install of the index MD Tools in action\n\n\u003cbr\u003e\n\n[🔝 Back to Top](#table-of-contents)\n\n---\n\n## indexMD Control Panel\n\n```bash\npy cli.py\n```\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"screenshots/cli-panel.gif\"\u003e\n    \u003cimg src=\"screenshots/cli-panel.gif\" alt=\"indexMD CLI Panel\" width=\"700\"/\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n🧠 A simple yet powerful command-line interface to manage your documentation workflow easily:  \nBuild, Prepare, Serve, Deploy, or just Check version — all in one menu!\n\n### CLI Options Explained\n\n| Option | Description |\n|--------|-------------|\n| `1. Build Documentation` | Generates the static site using `mkdocs build`. |\n| `2. Prepare README` | Converts the `README.md` into `index.md` for homepage. |\n| `3. Serve Locally` | Launches a local dev server using `mkdocs serve`. |\n| `4. Deploy` | Deploys the site to GitHub Pages using `mkdocs gh-deploy`. |\n| `5. Check Version` | Displays current versions of key tools like MkDocs. |\n| `6. Exit` | Exits the CLI interface. |\n\n\u003cbr\u003e\n\n[🔝 Back to Top](#table-of-contents)\n\n---\n\n## Project Structure\n\nThe following is the structure of the main project directory:\n\n```text\n./\n├── 📁 docs/\n│   ├── 📁 sections/\n│   │   ├── about.md\n│   │   ├── contact.md\n│   │   ├── important-links.md\n│   │   ├── privacy.md\n│   │   └── terms.md\n│   ├── 📁 stylesheets/\n│   │   └── extra.css\n│   └── index.md\n├── 📁 overrides/\n│   └── 📁 partials/\n│       ├── footer.html\n│       └── header.html\n├── .gitignore\n├── LICENSE\n├── README.md\n├── build_all.py\n├── cli.py\n├── mkdocs.yml\n├── prepare_docs.py\n└── requirements.txt\n\n```\n\u003cbr\u003e\n\n[🔝 Back to Top](#table-of-contents)\n\n---\n\n## 📦 Install via pip (coming soon)\n\nThis project will soon be available on PyPI for easy installation.\n\nOnce published, you will be able to install it using:\n\n```bash\npip install indexmd\n\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftameronline%2Findexmd","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftameronline%2Findexmd","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftameronline%2Findexmd/lists"}