Recipes
1 minute read
Available recipes
Recipes for publishing and structuring a documentation site.
Deploy
- Deploy to Cloudflare Pages — Build with the engine and publish to Cloudflare Pages.
- Custom domain — Point a custom domain at the site and set its published URL.
- Deploy to GitLab Pages — Build and publish the output with GitLab CI/CD.
- Deploy to Netlify — Build with the engine and publish the output to Netlify.
- Deploy to Vercel — Build with the engine, publish to Vercel, and serve the Markdown twins correctly.
Structure
- Documentation from a docs/ folder — Host the site next to the code it documents.
- Redirects — Keep old URLs working when a page moves.
- Versioned documentation — Publish
/v1/,/v2/, and/latest/from one repository.