Skip to content
Vellum

Credits

The open source Vellum is built on, and the work it takes its cues from.

Vellum is built on other people's open source work. This page lists the projects it uses and the ones it borrows ideas from.

Inspiration

Vellum's design follows Fumadocs. The sidebar and table-of-contents layout, the ::: directive syntax, code tabs with a shared chrome, and the approach of treating a docs framework as a design system all come from Fumadocs. Fumadocs is a React and Next.js project. Vellum provides the same kind of docs site for a Laravel app, without adding a second codebase. If you are building on Next.js, use Fumadocs.

The syntax highlighting palette is GitHub Light and GitHub Dark, the Shiki themes Fumadocs uses by default, so code looks the way it does on GitHub and in most editors.

Rendering

Package What it does
league/commonmark CommonMark and GitHub Flavored Markdown. Vellum's directives, callouts, tabs, steps and cards are extensions on top of it.
tempest/highlight Server-side syntax highlighting, so no highlighter ships to the browser.
league/config The options schema CommonMark's extensions, including Vellum's, are configured through.
symfony/yaml Page frontmatter.
symfony/process Runs git to find when each page last changed.
tales-from-a-dev/tailwind-merge-php Resolves conflicting Tailwind classes when a component's classes are overridden.

Interface

Package What it does
Phosphor Icons Every icon in the chrome, the callout glyphs and the code-block language marks. Regular weight for chrome, fill for glyphs. MIT.
Tailwind CSS The stylesheet, built to a single file at release time.
Alpine.js The theme toggle, tabs, dialogs, sidebar and table-of-contents behaviour, with the anchor, collapse and focus plugins.
Vite Builds the CSS and JS bundles.

Foundations

Vellum relies on Laravel for routing, Blade, caching, gates and config, which is what lets the docs run inside the app you already deploy.

Testing and quality tooling: Pest, Orchestra Testbench, PHPStan with Larastan, and Laravel Pint.

Search ranks sections with BM25, using the scoring constants of MiniSearch, which Vellum used for search before 0.7.

Licences

Vellum is MIT licensed. Every package above is MIT or BSD licensed. Run composer licenses in your app to see the exact terms for the versions you have installed.