https://github.com/fuma-nama/nextjs-fumadocs
View Next.js docs with Fumadocs
https://github.com/fuma-nama/nextjs-fumadocs
fumadocs
Last synced: 5 months ago
JSON representation
View Next.js docs with Fumadocs
- Host: GitHub
- URL: https://github.com/fuma-nama/nextjs-fumadocs
- Owner: fuma-nama
- Created: 2025-01-17T13:31:11.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2025-02-16T07:36:07.000Z (8 months ago)
- Last Synced: 2025-05-07T12:18:10.713Z (5 months ago)
- Topics: fumadocs
- Language: TypeScript
- Homepage: https://nextjs-fumadocs.vercel.app
- Size: 654 KB
- Stars: 14
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Next.js Fumadocs
View the Next.js docs with Fumadocs.
You can also use it to preview your pull request when contributing to the docs.
https://nextjs-fumadocs.vercel.app
### Preview in Development Mode
This example fetches content from Next.js repo using GitHub API, make sure to put your GitHub token in `.env.local` in `GITHUB_TOKEN` variable.
You can also preview content locally with:
```bash
pnpm sync:docs
pnpm dev:local
```
This will clone the Next.js repo using Git Submodules (`git submodule update --init`).
`dev:local` command will preview the docs using local file system instead of GitHub API.
### ISR in Production Mode
```bash
pnpm build
```
For production build, it clones the docs content from `vercel/next.js` repo, and pre-render them locally. Vercel supports Git Submodules by default, hence no further configurations are needed.
Once deployed/started in production mode, it will instead use GitHub API to fetch the latest docs content, no need to re-trigger another build for new content updates.