Generating files

Generate components pages

To generate MD files from /packages/components run yarn generate:components:docs in this directory.

Watch file changes

To watch the source files for changes use yarn generate:watch. This command updates the MD files when any change is made to component source file.

Adding an example

Add new JS file to /examples/<component name>/<example-name>.js. The component name must be the same as the component MD file.

Create normal React component and use default export. Component will be added to the MD file after running yarn generate:components:docs again.

Dev server

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.js. The page auto-updates as you edit the file.

Learn More

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

• Next.js Documentation - learn about Next.js features and API.
• Learn Next.js - an interactive Next.js tutorial.

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.