Your docs site is ready
Welcome to your new docs site
Add a docs.json and at least one .mdxfile to your repo to publish your first page. We’ll rebuild and deploy on every push to main.
Two files to get started
Drop these into your repo, push to main, and refresh.
docs.json{
"name": "My docs",
"navigation": [
{
"group": "Getting started",
"pages": ["introduction"]
}
]
}
docs/introduction.mdx---
title: Introduction
description: Welcome to your new documentation site.
---
# Introduction
Welcome! This is your first page.
Edit `docs/introduction.mdx` in your repo to start writing — push to
`main` and your changes go live automatically.
What it’ll look like
A live preview of how your MDX will render once published.
Hello, docs
Paragraphs render as you'd expect, and inline code looks like this.
Code blocks get syntax highlighting:
function greet(name: string) {
return `Hello, ${name}!`;
}