https://github.com/zentered/next-product-docs-example
Example Repo for https://github.com/opstrace/next-product-docs
https://github.com/zentered/next-product-docs-example
documentation nextjs
Last synced: about 1 year ago
JSON representation
Example Repo for https://github.com/opstrace/next-product-docs
- Host: GitHub
- URL: https://github.com/zentered/next-product-docs-example
- Owner: zentered
- Created: 2021-06-02T06:38:30.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2023-03-23T10:58:16.000Z (over 3 years ago)
- Last Synced: 2025-03-28T20:07:39.989Z (about 1 year ago)
- Topics: documentation, nextjs
- Language: JavaScript
- Homepage:
- Size: 1.99 MB
- Stars: 8
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 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](https://zentered.co/articles/product-documentation-with-nextjs)
- [Check out the component repo with complete installation and usage instructions](https://github.com/zentered/next-product-docs)
## Installation
```bash
npm install
# or pnpm install
# or yarn install
```
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](https://github.com/settings/tokens) with the correct
permissions as `GITHUB_TOKEN`.
## Local Development
1. Clone [next-product-docs](https://github.com/zentered/next-product-docs) to
./next-product-docs
2. Create a project folder in the same level as next-product-docs
```bash
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.