Quickstart

1. Add your docs#

In a new folder, create a docs.json file:

{  "name": "My docs",  "navigation": {    "groups": [      {        "group": "Guide",        "pages": ["index"]      }    ]  }}

Then add the first page:

---title: Introductiondescription: Welcome to my docs---Hello, world.

2. Install the CLI#

Install the package globally:

npm install -g @upstash/docs7

This adds the docs7 command to your terminal.

3. Start the dev server#

Run this from the folder that contains docs.json:

docs7 dev

Open http://localhost:3333. The page reloads when you edit a file.

The first run downloads the renderer and caches it for later. You can also pass a project folder or use another port:

docs7 dev ./docs --port 4000

4. Publish#

1. Push the project to GitHub.
2. Open the Docs7 tab in your Context7 teamspace.
3. Click Add New Site and choose the repository.
4. Set the production branch and the folder that contains docs.json.
5. Click Publish Site.

Every push to the production branch creates a new deployment. Pull requests get a preview site.

Next, see the components you can use in MDX.