Vellum
Markdown documentation sites that ship with your Laravel app.
Vellum serves a folder of Markdown as a documentation site from the Laravel app you already deploy. It includes a sidebar, search, light and dark themes, and an optional static export.
You write pages in Markdown. The built-in callouts, tabs, steps and cards use ::: directives, and <x-…> tags add your own Blade components and the allowlisted env, config and route value tags. Blade syntax such as {{ }}, @if and @php is not compiled in Markdown files.
Note
config/vellum.php keys and page frontmatter have been frozen since 0.5. Breaking changes wait for 1.0.
Require the package
composer require jimmyverburgt/vellum
Publish stubs
php artisan vellum:install
Open the site
Visit /docs and edit resources/docs/.
What is VellumA Laravel package that serves a folder of Markdown as a documentation site from your app, or exports it as a static site.InstallationRequirements, installing the package, and the build step for production.Writing MarkdownThe Markdown flavour Vellum renders and where it departs from GitHub.ComponentsThe built-in directives and value tags.NavigationHow the sidebar is built from folders, meta.json, and frontmatter.ExtendingRegister Blade components for use in Markdown.