User Documentation

Introduction

This starter kit uses Nextra (opens in a new tab) for user documentation. Write user docs and help guides to assist your users with using your software or product.

Create a documentation page

To create a documentation page, create a .mdx file in the pages/docs directory. For example, to create a page titled "My Page", create a file in the pages/docs directory named my-page.mdx containing the following code.

# My Page - Welcome
 
Welcome to my page!

Then go to the _meta.json file in the same directory and add the following code:

{
  ...,
  "my-page": "My Page"
}

This will add your page to the navigation sidebar.

Tips

• The pages/docs/index.mdx page has many MDX syntax examples for your reference.
• Consult the official Nextra documentation (opens in a new tab) for more information on how to use Nextra.
• Consult the MDX documentation (opens in a new tab) for more information about MDX and its syntax.