Download the PHP package superinteractive/statamic-super-documentation without Composer
On this page you can find all versions of the php package superinteractive/statamic-super-documentation. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download superinteractive/statamic-super-documentation
More information about superinteractive/statamic-super-documentation
Files in superinteractive/statamic-super-documentation
Package statamic-super-documentation
Short Description Serve VitePress documentation behind the Statamic CP.
License MIT
Informations about the package statamic-super-documentation
Super Documentation
A Statamic 5 and 6 addon that serves VitePress-built documentation behind the Statamic Control Panel's authenticated routes.
Installation
1. Require the addon
2. Install VitePress
3. Build the documentation
4. Publish the config (optional)
Local Development
When developing this package with the Super Statamic Starter Kit source app, work from the package repository:
The Control Panel assets are powered by Vite. During development, run:
Configuration
Published to config/statamic/super-documentation.php:
| Key | Type | Default | Description |
|---|---|---|---|
docs_source_path |
string |
'resources/docs/src' |
Path to VitePress source (relative to project root) |
docs_dist_path |
string |
'resources/docs/dist' |
Path to VitePress build output (relative to project root) |
button_label |
string |
'Documentation' |
Text shown on the CP header button |
Writing Documentation
Documentation source files live at resources/docs/src/ (configurable). Add Markdown files following VitePress conventions.
Local preview
Build for production
VitePress Base Path
The VitePress base in .vitepress/config.ts must match the Statamic CP route prefix. The default is /cp/documentation/. If your CP route is changed via the CP_ROUTE environment variable, update the base accordingly and rebuild.
All versions of statamic-super-documentation with dependencies
laravel/framework Version ^10.0 || ^11.0 || ^12.0 || ^13.0
statamic/cms Version ^5.0 || ^6.0