Page Configuration

Each MDX file requires metadata between --- lines at the start:

Page Modes

Choose from three display modes:

  • Default: Standard layout with table of contents
  • Wide: Hides table of contents (mode: "wide")
  • Custom: Minimal layout with only top bar (mode: "custom")

API Pages

Enable API playgrounds by adding the api or openapi property:

---
api: "GET /users"
# or
openapi: "GET /users"
---

SEO Optimization

Add meta tags for social sharing and SEO:

---
"twitter:image": "/images/your-photo.jpg"
# Add other meta tags as needed
---

For all supported meta tags, see SEO settings.

Was this page helpful?