Quickstart

There are two ways to get started with Nextra418.

🚀 One-Click Deploy

The fastest and easiest way to start. Click the button below to clone the repository to your GitHub and automatically deploy to Vercel:

💻 Local Development

If you want to develop and customize locally, please follow these steps:

Clone Repository

First, clone the repository to your local machine:


git clone git@github.com:notURandomDev/nextra418.git
cd nextra418

Install Dependencies

pnpm is recommended:

pnpm


pnpm i

npm


npm i

yarn


yarn install

Run Local Server

pnpm


pnpm dev

npm


npm run dev

yarn


yarn dev

That’s it—your local server is now running! 🎉 Visit http://localhost:3000 to see your documentation.

🎨 Customize Your Content

Once the local server is running, you can start customizing your content:

Configure Site Metadata

Update site title, logo, SEO, and other basic info in app/_config/layout.config.tsx and app/_config/meta.config.tsx.

Write Documentation

Add MDX files in the content directory. You can refer to the existing file structure.

Organize Sidebar Structure

Control the menu order and titles using _meta.ts files in each directory.

For detailed instructions, see Core Configuration and Writing Content.

🌐 Deployment

If you cloned and developed locally, push your code to GitHub and then import the project on Vercel for deployment. Vercel will automatically detect the Next.js project and finish the build.