Gui Bibeau
ec362e2ae9
docs: improve React section documentation (#211)
|
2 kuukautta sitten | |
|---|---|---|
| .. | ||
| content | 2 kuukautta sitten | |
| public | 5 kuukautta sitten | |
| src | 2 kuukautta sitten | |
| .eslintrc.json | 6 kuukautta sitten | |
| .gitignore | 5 kuukautta sitten | |
| .npmrc | 6 kuukautta sitten | |
| .prettierignore | 2 kuukautta sitten | |
| .prettierrc | 5 kuukautta sitten | |
| README.md | 5 kuukautta sitten | |
| build-api-docs.sh | 5 kuukautta sitten | |
| generic.d.ts | 2 kuukautta sitten | |
| next.config.mjs | 6 kuukautta sitten | |
| package.json | 2 kuukautta sitten | |
| pnpm-lock.yaml | 2 kuukautta sitten | |
| postcss.config.mjs | 6 kuukautta sitten | |
| source.config.ts | 5 kuukautta sitten | |
| tsconfig.json | 6 kuukautta sitten | |
| typedoc-data.mjs | 2 kuukautta sitten | |
| vercel.json | 5 kuukautta sitten | |
README.md
gill documentation
Documentation website for gill, built with Fumadocs.
Install dependencies
Install using the --ignore-workspace flag to ensure the dependencies of the documentation website
are separate from the library dependencies.
pnpm install --ignore-workspace
Run development server
pnpm dev
Open http://localhost:3000 with your browser to see the result.
Generating the API references documentation
The docs have a prebuild command that will generate API docs (via TypeDoc) for the library's
packages.
When working locally, it is not required to build these in order to test the local docs site.
You can manually trigger building the API references using the following command:
pnpm prebuild
Learn more
To learn more about Next.js and Fumadocs, 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.
- Fumadocs - learn about Fumadocs