mirror of
https://github.com/dathere/ckan-devstaller.git
synced 2025-11-09 13:39:49 +00:00
| .. | ||
| app | ||
| components/ui | ||
| content/docs | ||
| lib | ||
| public | ||
| .env.example | ||
| .gitignore | ||
| .nvmrc | ||
| biome.json | ||
| bun.lock | ||
| mdx-components.tsx | ||
| next.config.mjs | ||
| package.json | ||
| postcss.config.mjs | ||
| README.md | ||
| source.config.ts | ||
| tsconfig.json | ||
ckan-devstaller docs website (ckan-devstaller.dathere.com)
This directory includes a Next.js project built with Fumadocs for documentation of ckan-devstaller. The documentation can be viewed at ckan-devstaller.dathere.com.
We attempt to follow the Divio documentation system which primarily includes:
- Tutorials
- How-to guides
- Explanation
- Reference
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.
| 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.