# Vellum

> Markdown documentation sites that ship with your Laravel app.

## Vellum

- [Vellum](https://vellum.jimmyverburgt.com/docs/_vellum/raw/index.md): Markdown documentation sites that ship with your Laravel app.
- [What is Vellum](https://vellum.jimmyverburgt.com/docs/_vellum/raw/why.md): A Laravel package that serves a folder of Markdown as a documentation site from your app, or exports it as a static site.
- [Comparisons](https://vellum.jimmyverburgt.com/docs/_vellum/raw/comparisons.md): How Vellum differs from LaRecipe, the other package that serves Markdown documentation from inside a Laravel app.

## Getting started

- [Installation](https://vellum.jimmyverburgt.com/docs/_vellum/raw/getting-started/installation.md): Requirements, installing the package, and the build step for production.
- [Configuration](https://vellum.jimmyverburgt.com/docs/_vellum/raw/getting-started/configuration.md): Every config key and frontmatter field, all frozen since 0.5.
- [Upgrade](https://vellum.jimmyverburgt.com/docs/_vellum/raw/getting-started/upgrade.md): Upgrading from 0.8 to 0.9, from 0.7 to 0.8, from 0.6 to 0.7, within 0.6, from 0.5 to 0.6, and from 0.2 to the 0.5 freeze.

## Writing

- [Markdown](https://vellum.jimmyverburgt.com/docs/_vellum/raw/writing/markdown.md): The Markdown flavour Vellum renders and where it departs from GitHub.
- [Code blocks](https://vellum.jimmyverburgt.com/docs/_vellum/raw/writing/code-blocks.md): Titles, line numbers, highlighted lines, and inline code with a language.
- [Images](https://vellum.jimmyverburgt.com/docs/_vellum/raw/writing/images.md): Where image files live, how they are served, and the attributes Vellum adds.
- [Navigation](https://vellum.jimmyverburgt.com/docs/_vellum/raw/writing/navigation.md): How the sidebar is built from folders, meta.json, and frontmatter.

## Components

- [Components](https://vellum.jimmyverburgt.com/docs/_vellum/raw/components.md): The built-in directives and value tags.
- [Callouts](https://vellum.jimmyverburgt.com/docs/_vellum/raw/components/callouts.md): Notes, tips, warnings, and related asides.
- [Tabs](https://vellum.jimmyverburgt.com/docs/_vellum/raw/components/tabs.md): Switchable panels, including code tabs.
- [Steps](https://vellum.jimmyverburgt.com/docs/_vellum/raw/components/steps.md): Numbered procedures from headings.
- [Cards](https://vellum.jimmyverburgt.com/docs/_vellum/raw/components/cards.md): Link cards in a two-up grid.

## Vellum (continued)

- [Value tags](https://vellum.jimmyverburgt.com/docs/_vellum/raw/value-tags.md): Allowlisted env, config, and route lookups that resolve against the live app.
- [Versions](https://vellum.jimmyverburgt.com/docs/_vellum/raw/versions.md): Version folders, unprefixed URLs for the latest version, and the version switcher.
- [Gating](https://vellum.jimmyverburgt.com/docs/_vellum/raw/gating.md): Hide pages from guests, require auth, or require a Laravel gate.
- [Search](https://vellum.jimmyverburgt.com/docs/_vellum/raw/search.md): Built-in search in the browser by default, with Laravel Scout as an option.
- [API reference](https://vellum.jimmyverburgt.com/docs/_vellum/raw/api-reference.md): Reference pages generated from an OpenAPI spec, from a file or from Scramble.
- [Release notes](https://vellum.jimmyverburgt.com/docs/_vellum/raw/releases.md): Keep a Changelog page and Atom feed.
- [Export](https://vellum.jimmyverburgt.com/docs/_vellum/raw/export.md): Write a static HTML site for GitHub Pages, Cloudflare Workers, or any static host.
- [Search engines](https://vellum.jimmyverburgt.com/docs/_vellum/raw/seo.md): The metadata Vellum outputs for crawlers, the sitemap route, and what to put in robots.txt.
- [Commands](https://vellum.jimmyverburgt.com/docs/_vellum/raw/commands.md): The five Artisan commands Vellum adds, and when to run each one.
- [Troubleshooting](https://vellum.jimmyverburgt.com/docs/_vellum/raw/troubleshooting.md): The errors Vellum raises, what each one means, and the failures that raise no error.
- [Theming](https://vellum.jimmyverburgt.com/docs/_vellum/raw/theming.md): Three contrast-tested presets, a brand accent, corner radius, and a light, dark or system default.
- [Page actions](https://vellum.jimmyverburgt.com/docs/_vellum/raw/page-actions.md): Copy Markdown, raw source URLs, llms.txt, Edit on GitHub, and opening a page in ChatGPT or Claude.
- [Extending with your own components](https://vellum.jimmyverburgt.com/docs/_vellum/raw/extending.md): Register Blade components for use in Markdown.
- [Core on its own](https://vellum.jimmyverburgt.com/docs/_vellum/raw/core.md): Use Vellum's content engine without its routes and layout.
- [Credits](https://vellum.jimmyverburgt.com/docs/_vellum/raw/credits.md): The open source Vellum is built on, and the work it takes its cues from.
- [Changelog](https://vellum.jimmyverburgt.com/docs/_vellum/raw/changelog.md): Release notes

## Example API

- [Overview](https://vellum.jimmyverburgt.com/docs/_vellum/raw/api.md): An example, to show what Vellum makes of an OpenAPI spec. Harbor manages ships and berths for a harbor that does not exist.
- [List ships](https://vellum.jimmyverburgt.com/docs/_vellum/raw/api/ships/list-ships.md): Returns ships in the order they registered. Use cursor to page.
- [Register a ship](https://vellum.jimmyverburgt.com/docs/_vellum/raw/api/ships/register-ship.md): Adds a ship to the harbor's register.
- [Get a ship](https://vellum.jimmyverburgt.com/docs/_vellum/raw/api/ships/get-ship.md)
- [Remove a ship](https://vellum.jimmyverburgt.com/docs/_vellum/raw/api/ships/remove-ship.md)
- [Assign a berth](https://vellum.jimmyverburgt.com/docs/_vellum/raw/api/berths/assign-berth.md)
- [Health check](https://vellum.jimmyverburgt.com/docs/_vellum/raw/api/other/get-health.md)
- [Ship arrived](https://vellum.jimmyverburgt.com/docs/_vellum/raw/api/webhooks/ship-arrived.md): Sent to the webhook address set on your account when a ship ties up at a berth. This example never sends it.