mirror of
https://github.com/dathere/ckanaction.git
synced 2025-11-09 14:19:49 +00:00
| .. | ||
| app | ||
| content/docs | ||
| lib | ||
| public | ||
| scripts | ||
| .gitignore | ||
| .nvmrc | ||
| biome.json | ||
| bun.lock | ||
| mdx-components.tsx | ||
| next.config.mjs | ||
| package.json | ||
| postcss.config.mjs | ||
| README.md | ||
| source.config.ts | ||
| tsconfig.json | ||
ckanaction docs website (ckanaction.dathere.com)
This directory includes a Next.js project built with Fumadocs for documentation of ckanaction. The documentation can be viewed at ckanaction.dathere.com.
Development
Run development server:
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 runningbun ./scripts/generate-docs.tsto generate the relevant docs files incontent/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 for linting. We recommend you install the biome-vscode extension if you are using VSCodium or VSCode for developing the docs.