Skip to content

📦 indexMD – Markdown-Based Documentation Generator

A lightweight documentation generator powered by MkDocs and custom scripts to automate README-based documentation deployment.

License: MIT View Wiki Docs

GitHub Stars GitHub Forks GitHub Issues GitHub Pull Requests

Python Version MkDocs Version Pip Version

GitHub Actions Code Quality Last Commit Contributors

Built with ❤️ by Tamer

📖 Full Documentation – Wiki

Need step-by-step guides on installation, usage, customization, or contributions?
Explore the official project Wiki for complete technical documentation:

➡️ View the Wiki

👤 📝 Maintained and regularly updated for all user levels: beginners, contributors, and advanced users.

indexMD CLI Control Panel

Features

  • 📄 Markdown-based documentation
  • 📦 MkDocs for static site generation
  • 📑 Custom HTML overrides
  • 🌐 Customizable themes and styles
  • 📖 Multi-section support (About, Contact, Privacy, Terms…)
  • 🔗 Important links section


Clone the Repository

To get started, clone this repository to your local machine using Git:

git clone https://github.com/TamerOnline/indexMD.git
cd indexMD

Quick clone-the-repository

📽️ Quick Clone of the indexMD repository in action


Quick Start

Create Virtual Environment

# Windows
py -3.12 -m venv venv
.\venv\Scripts\Activate

Encryption Service Tools Windows

📽️ Quick setup of indexMD on Windows in action


# macOS / Linux
python3 -m venv venv
source venv/bin/activate

Before installing dependencies, it's recommended to upgrade pip to the latest version to avoid compatibility issues.

python -m pip install --upgrade pip

Upgrade pip Tools Windows

📽️ Upgrading pip on Windows (recommended)


Install Dependencies

pip install -r requirements.txt

index MD Tools install

📽️ Quick install of the index MD Tools in action


indexMD Control Panel

py cli.py

indexMD CLI Panel

🧠 A simple yet powerful command-line interface to manage your documentation workflow easily:
Build, Prepare, Serve, Deploy, or just Check version — all in one menu!

CLI Options Explained

Option Description
1. Build Documentation Generates the static site using mkdocs build.
2. Prepare README Converts the README.md into index.md for homepage.
3. Serve Locally Launches a local dev server using mkdocs serve.
4. Deploy Deploys the site to GitHub Pages using mkdocs gh-deploy.
5. Check Version Displays current versions of key tools like MkDocs.
6. Exit Exits the CLI interface.


Project Structure

The following is the structure of the main project directory:

./
├── 📁 docs/
│   ├── 📁 sections/
│   │   ├── about.md
│   │   ├── contact.md
│   │   ├── important-links.md
│   │   ├── privacy.md
│   │   └── terms.md
│   ├── 📁 stylesheets/
│   │   └── extra.css
│   └── index.md
├── 📁 overrides/
│   └── 📁 partials/
│       ├── footer.html
│       └── header.html
├── .gitignore
├── LICENSE
├── README.md
├── build_all.py
├── cli.py
├── mkdocs.yml
├── prepare_docs.py
└── requirements.txt

📦 Install via pip (coming soon)

This project will soon be available on PyPI for easy installation.

Once published, you will be able to install it using:

```bash pip install indexmd