A clean, full-featured starter template for building beautiful documentation with Relevate.

This is the official starter template for creating your documentation with Relevate. It includes a comprehensive set of predefined components, fully configured navigation, and a structure that is easy to extend and customize for your own needs.

Use this template as a starting point to skip boilerplate setup and dive straight into writing your docs!

starter/
├── docs.json                    # Main Relevate configuration
├── index.mdx                    # Homepage
├── quickstart.mdx               # Quickstart guide example
├── concepts.mdx                 # Concepts guide example
├── api/                         # API reference pages
├── components/                  # UI component examples and guides
├── config/                      # Configuration reference and guides
├── openapi.json                 # OpenAPI spec example
└── public/                      # Static assets (images, logos)

To view the starter template locally, use the Relevate CLI:

relevate preview

To run accessibility tests:

relevate a11y

Edit docs.json to customize your docs' appearance, navigation, and settings:

• Update the name and branding colors
• Modify the navigation structure to match your content
• Change the logo and favicon (place your assets in the public directory)

Start writing your guides in MDX format. You can use standard Markdown along with Relevate's built-in components like <Note>, <CodeGroup>, <Card>, etc. Review the components/ directory for examples of all available interactive components.

This template includes setup for API reference documentation:

• Check out the api/ directory for examples of how to document endpoints manually.
• Or use the included openapi.json file to auto-generate API reference docs.

Check out the official Relevate documentation for detailed guides on all available features and components.

Built with: Relevate