datHere/ckanaction
1
0
Fork 0
mirror of https://github.com/dathere/ckanaction.git synced 2025-11-09 14:19:49 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
ckanaction/docs
History
rzmk ebbe179fbf chore(docs): update endpoints to use POST requests
2025-10-22 06:48:42 -04:00
..
app feat(docs): initial interactive ckanaction docs web app 2025-10-12 16:26:21 -04:00
content/docs chore(docs): update endpoints to use POST requests 2025-10-22 06:48:42 -04:00
lib chore(docs): update endpoints to use POST requests 2025-10-22 06:48:42 -04:00
public feat(docs): add GIF, GitHub URL, and more endpoints 2025-10-12 21:13:17 -04:00
scripts feat(docs): initial interactive ckanaction docs web app 2025-10-12 16:26:21 -04:00
.gitignore feat(docs): initial interactive ckanaction docs web app 2025-10-12 16:26:21 -04:00
biome.json feat(docs): initial interactive ckanaction docs web app 2025-10-12 16:26:21 -04:00
bun.lock build(docs): use latest nextjs and fumadocs with default unset value fix 2025-10-22 06:40:40 -04:00
mdx-components.tsx feat(docs): initial interactive ckanaction docs web app 2025-10-12 16:26:21 -04:00
next.config.mjs build(docs): use latest nextjs and fumadocs with default unset value fix 2025-10-22 06:40:40 -04:00
package.json build(docs): use latest nextjs and fumadocs with default unset value fix 2025-10-22 06:40:40 -04:00
postcss.config.mjs feat(docs): initial interactive ckanaction docs web app 2025-10-12 16:26:21 -04:00
README.md chore(docs): remove - from ckan-action in README 2025-10-12 16:38:35 -04:00
source.config.ts feat(docs): initial interactive ckanaction docs web app 2025-10-12 16:26:21 -04:00
tsconfig.json build(docs): use latest nextjs and fumadocs with default unset value fix 2025-10-22 06:40:40 -04:00

README.md

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 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 for linting. We recommend you install the biome-vscode extension if you are using VSCodium or VSCode for developing the docs.