Getting Started

Create a New App

To get started, run:

npx create-nexd-app

Then run:

npm run nexd

What is npm run nexd ?

Creating a New Documentation Page

Nexd follows the Next.js app router's file-based routing convention. To create a new documentation page, add your files under the docs folder.

Example: Creating a Documentation Website with Two Pages

To create a documentation website with the following structure:

  • /docs/getting-started
  • /docs/components

You need to create two page.mdx files as follows:

nexd
└── src/
    └── docs/
        ├── getting-started/
        │   └── page.mdx
        └── components/
            └── page.mdx

Start Writing MDX

With the structure in place, you can start writing MDX content inside these files and enjoy creating rich documentation pages!