jimmyverburgt / vellum

v0.1.0 2026-09-11 21:16 UTC

Requires

• php: ^8.4
• illuminate/console: ^11.0|^12.0|^13.0
• illuminate/contracts: ^11.0|^12.0|^13.0
• illuminate/http: ^11.0|^12.0|^13.0
• illuminate/routing: ^11.0|^12.0|^13.0
• illuminate/support: ^11.0|^12.0|^13.0
• illuminate/view: ^11.0|^12.0|^13.0
• league/commonmark: ^2.6
• symfony/yaml: ^7.0|^8.0
• tales-from-a-dev/tailwind-merge-php: ^0.4
• tempest/highlight: ^2.28

Requires (Dev)

• larastan/larastan: ^3.0
• laravel/pint: ^1.18
• orchestra/testbench: ^9.0|^10.0|^11.0
• pestphp/pest: ^3.0|^4.0|^5.0
• pestphp/pest-plugin-laravel: ^3.0|^4.0|^5.0

MIT

• Jimmy Verburgt

• documentation
• markdown
• docs
• laravel
• vellum

Published on Packagist.org on 2026-09-11 21:33 UTC

README

Markdown documentation sites for Laravel.

Pre-1.0: the API may change.

Requirements

• PHP 8.4+
• Laravel 11, 12, or 13

Quick start

composer require jimmyverburgt/vellum
php artisan vellum:install

Open /docs. Edit Markdown under resources/docs/.

Compile the cache during deploy:

php artisan vellum:build

What it includes

• Markdown extensions: callouts, tabs, steps, cards, code blocks, heading anchors
• Client-side search
• Optional versioned docs
• Static HTML export (vellum:export)
• Light / dark / system theme

Screenshots

Light:

Dark:

Demo

Stub docs deploy via Cloudflare Workers (wrangler.toml + committed demo-dist).

Cloudflare Git build settings:

• Build command: leave empty
• Deploy command: npx wrangler deploy

Regenerate the static export locally after stub changes: bash bin/build-demo

Configuration

config/vellum.php (published by vellum:install).

Commands

Command	Description
php artisan vellum:install	Publish config, starter Markdown stubs, and public assets
php artisan vellum:build	Compile Markdown into the Vellum cache
php artisan vellum:clear	Clear the compiled cache
php artisan vellum:export	Export a static HTML site (--out= optional)

Publishing

git tag v0.1.0
git push origin v0.1.0

Submit the repo once at https://packagist.org/packages/submit. Packagist reads the Git tag; do not add a version field to composer.json.

License

MIT. See LICENSE.md.