Installation
Requirements, installing the package, and the build step for production.
Requirements
- PHP 8.4+
- Laravel 11, 12, or 13
Install
Require the package
composer require jimmyverburgt/vellum
This installs the docs site and jimmyverburgt/vellum-core, the engine it runs on. To render the docs in your own front end instead, see Core on its own.
Publish config, stubs, and assets
php artisan vellum:install
vellum:install publishes config/vellum.php, copies starter Markdown into resources/docs and copies the compiled CSS and JavaScript to public/vendor/vellum.
Open the site
Visit /docs, then edit the files in resources/docs/.
Production
Compile the Markdown once per deploy:
php artisan vellum:build
In the local environment pages recompile on request as you edit them, so you only need this
command in your deploy. See Commands.
Next
- Markdown for the Markdown syntax Vellum renders
- Navigation to arrange the sidebar
- Configuration for every config key and frontmatter field
- Commands for what to run in a deploy
- Upgrade if you are upgrading from an earlier version
- Troubleshooting when a page does not render