Download the PHP package jimmyverburgt/vellum without Composer
On this page you can find all versions of the php package jimmyverburgt/vellum. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download jimmyverburgt/vellum
More information about jimmyverburgt/vellum
Files in jimmyverburgt/vellum
Package vellum
Short Description Markdown documentation sites for Laravel
License MIT
Homepage https://github.com/VerburgtJimmy/vellum
Informations about the package vellum
Vellum
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
Open /docs and edit Markdown under resources/docs/. Compile once per deploy:
What it includes
- Markdown plus components:
:::callouts, tabs, steps and cards, your own<x-…>Blade components, and allowlistedenv,configandroutetags 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
authand 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.
All versions of vellum with dependencies
illuminate/console Version ^11.0|^12.0|^13.0
illuminate/contracts Version ^11.0|^12.0|^13.0
illuminate/http Version ^11.0|^12.0|^13.0
illuminate/routing Version ^11.0|^12.0|^13.0
illuminate/support Version ^11.0|^12.0|^13.0
illuminate/view Version ^11.0|^12.0|^13.0
league/commonmark Version ^2.6
symfony/yaml Version ^7.0|^8.0
tales-from-a-dev/tailwind-merge-php Version ^0.4
tempest/highlight Version ^2.28