VikramAIS/next-product-docs-example

Example Repo for https://github.com/opstrace/next-product-docs

Next.js Product Docs Minimal Example

This is an example repo for the Next.js Product Documentation component.

• Read the full article about the component
• Check out the component repo with complete installation and usage instructions

Installation

    npm install
    # or yarn install
    cp env.example .env

The remote repository for the docs can be configured through environment variables in .env. If your repository is private, you'll need to provide a Personal Access Token with the correct permissions as GITHUB_TOKEN.

Local Development

1. Clone next-product-docs to ./next-product-docs
2. Create a project folder in the same level as next-product-docs

  cd next-product-docs
  pnpm i
  pnpm build
  pnpm link .

  cd ../your-project-folder
  pnpm install @zentered/next-product-docs
  pnpm link @zentered/next-product-docs ../next-product-docs

You can continuously build & watch the component by running pnpm watch in the next-product-docs folder.