mirror of
https://github.com/dathere/ckanaction.git
synced 2025-11-09 14:19:49 +00:00
31 lines
1.5 KiB
Markdown
31 lines
1.5 KiB
Markdown
# ckan-action docs website (ckanaction.dathere.com)
|
|
|
|
This directory includes a Next.js project built with [Fumadocs](https://github.com/fuma-nama/fumadocs) for documentation of ckanaction. The documentation can be viewed at [ckanaction.dathere.com](https://ckanaction.dathere.com).
|
|
|
|
## Development
|
|
|
|
Run development server:
|
|
|
|
```bash
|
|
bun dev
|
|
```
|
|
|
|
Open http://localhost:3000 with your browser to see the result.
|
|
|
|
## Explore
|
|
|
|
In the project, you can see:
|
|
|
|
- `lib/source.ts`: Code for content source adapter, `loader()` provides the interface to access your content.
|
|
- `lib/layout.shared.tsx`: Shared options for layouts, optional but preferred to keep.
|
|
- `lib/openapi.yml`: The source file of the CKAN Actions API (v3) in an OpenAPI format which is then used in a script by running `bun ./scripts/generate-docs.ts` to generate the relevant docs files in `content/docs`.
|
|
|
|
| Route | Description |
|
|
| ------------------------- | ------------------------------------------------------ |
|
|
| `app/(home)` | The route group for your landing page and other pages. |
|
|
| `app/docs` | The documentation layout and pages. |
|
|
| `app/api/search/route.ts` | The Route Handler for search. |
|
|
|
|
## Linting
|
|
|
|
We use [Biome](https://biomejs.dev) for linting. We recommend you install the [biome-vscode extension](https://github.com/biomejs/biome-vscode) if you are using [VSCodium](https://vscodium.com/) or VSCode for developing the docs.
|