jimmyverburgt / vellum

v0.6.1 2026-09-19 19:24 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

Suggests

• laravel/scout: Required when vellum.search.driver is scout (Meilisearch or Typesense).

MIT

• Jimmy Verburgt

• documentation
• markdown
• docs
• laravel
• vellum

Published on Packagist.org on 2026-09-19 19:28 UTC

README

Documentation that ships with your Laravel app.

Vellum turns a folder of Markdown into a documentation site inside the app you already deploy: sidebar, search, light and dark themes, and an optional static export. No second codebase, no separate host, no copy of your config to keep in sync.

Read the docs · Config keys and page frontmatter have been frozen since 0.5. Breaking changes wait for 1.0.

Requirements

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

Quick start

composer require jimmyverburgt/vellum
php artisan vellum:install

Open /docs and edit Markdown under resources/docs/. Compile once per deploy:

php artisan vellum:build

What it includes

• Markdown plus components: ::: callouts, tabs, steps and cards, your own <x-…> Blade components, and allowlisted env, config and route tags that read the live app
• Code blocks with titles, line numbers and line highlighting, highlighted on the server
• Client-side search over a prebuilt index, or Laravel Scout
• Page gating through auth and your existing Laravel gates
• Optional versioned docs with an unprefixed latest
• Changelog page and Atom feed from a Keep a Changelog file
• Three contrast-tested colour presets and a brand accent, all holding WCAG AA
• Static HTML export for hosts that cannot run PHP

Documentation

vellum.jimmyverburgt.com — built with Vellum, so it is also the thing it documents.

• Installation and configuration
• Writing: Markdown, code blocks, images, navigation
• Components and extending with your own
• Commands and troubleshooting
• Upgrading

The same pages ship as Markdown in docs/, which is what the package renders at /docs once installed.

Commands

Command	Description
vellum:install	Publish config, starter Markdown, and assets
vellum:build	Compile Markdown and rebuild the search index
vellum:index	Rebuild the search index only
vellum:clear	Clear the compiled cache
vellum:export	Export a static HTML site

Credits

Vellum takes its shape from Fumadocs, and its icons from Phosphor. The full list is in docs/credits.md.

Contributing

See CONTRIBUTING.md. Security reports go through SECURITY.md.

Release notes are in CHANGELOG.md.

License

MIT. See LICENSE.md.