💊 Valtio makes proxy-state simple for React and Vanilla
Go to Latest

Basic things to know before adding docs

  • Docs live in docs/ folder.
  • Website lives in website/ folder.
  • Docs are written in mdx format.
  • Docs filename shouldn't have spaces.
  • Website would generate title and other metadata from graymatter in the file.
  • You should be able to render condesandbox inside mdx files by simply adding the url for the same
  • Once you have a doc, you can add it to the sidebar section by adding it to the nav in getDocsNav function inside website/lib/mdx.ts

This is a Next.js project bootstrapped with create-next-app.

Getting Started

First, run the development server:

npm run dev
# or
yarn dev

Open http://localhost:3000 with your browser to see the result.

You can start editing the page by modifying pages/index.tsx. The page auto-updates as you edit the file.

API routes can be accessed on http://localhost:3000/api/hello. This endpoint can be edited in pages/api/hello.ts.

The pages/api directory is mapped to /api/*. Files in this directory are treated as API routes instead of React pages.

Learn More

To learn more about Next.js, take a look at the following resources:

You can check out the Next.js GitHub repository - your feedback and contributions are welcome!

Deploy on Vercel

The easiest way to deploy your Next.js app is to use the Vercel Platform from the creators of Next.js.

Check out our Next.js deployment documentation for more details.