Welcome to Custom Documentation Example!

In this example you'll find an easy and slick way to implement your Readme content in a custom front-end using Next.js and Tailwind.

Getting Started

Install

yarn install
# or
npm install

Run

yarn dev
# or
npm run dev

Open http://localhost:3000 with your browser to see the result, this will redirect you to http://localhost:3000/docs where you'll be able to read the instructions on how to connect and modify the example.

Set up environment variables

In the Readme dashboard go get your API KEY in the Configuration > API KEY tab.

Next, copy the .env.local.example file in this directory to .env.local (which will be ignored by Git):

cp .env.local.example .env.local

Then set each variable on .env.local:

• README_AUTH_TOKEN should be the API token you just copied.

Your .env.local file should look like this:

README_AUTH_TOKEN=...

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!

To learn more about Tailwind, take a look at the following resources:

• Tailwind Documentation - learn about Tailwind customization features.

To learn more about Readme, take a look at the following resources:

• Readme Documentation - learn about Readme features and API.

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.