Skip to content

Documentation

The Phexium documentation is built with MkDocs and the Material for MkDocs theme.

Commands

task docs:install    # Install MkDocs dependencies
task docs:serve      # Start development server (http://localhost:8090/phexium/)
task docs:build      # Build static site

Project Structure

docs/                   # Source files
├── index.md           # Home page
├── getting-started/   # Installation guides
├── core-concepts/     # Architecture concepts
└── plugins/           # Plugin documentation

mkdocs.yml             # MkDocs configuration

Writing Documentation

Markdown Features

Code blocks with syntax highlighting:

```php
class Book {
    public function __construct(private readonly string $title) {}
}
```

Tables:

| Column 1 | Column 2 |
|----------|----------|
| Value 1  | Value 2  |

Add new pages to the nav section in mkdocs.yml.

GitLab Pages Deployment

Documentation is automatically deployed when pushing to the trunk branch. The site is available at https://phexium.com.

Troubleshooting

"externally-managed-environment" error

This is expected on Debian 12+, Ubuntu 23.04+. The framework uses a Python virtual environment (.venv-docs/) automatically via task docs:install.

Virtual environment corrupted

task docs:clean:all
task docs:install