Quick start
This page shows the shortest path from a fresh checkout to a running MDDocs documentation site.
Requirements
- PHP 8.4 or newer
- Composer 2
- a terminal in the project directory
Install dependencies
git clone https://github.com/devioarts/mddocs.git
cd mddocs
composer install
Start the web server
composer serve
Then open:
http://127.0.0.1:8080/mddocs
Build the search index
The search index can be built automatically on first search. To rebuild it manually, run:
composer build-search
Lint PHP files
composer lint
Start the MCP server
composer mcp
This command starts the stdio MCP server used by MCP clients.