diff --git a/docs/.gitignore b/docs/.gitignore
new file mode 100644
index 0000000..55a12ae
--- /dev/null
+++ b/docs/.gitignore
@@ -0,0 +1,28 @@
+# deps
+/node_modules
+
+# generated content
+.contentlayer
+.content-collections
+.source
+
+# test & build
+/coverage
+/.next/
+/out/
+/build
+*.tsbuildinfo
+
+# misc
+.DS_Store
+*.pem
+/.pnp
+.pnp.js
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# others
+.env*.local
+.vercel
+next-env.d.ts
\ No newline at end of file
diff --git a/docs/README.md b/docs/README.md
new file mode 100644
index 0000000..9a83d6d
--- /dev/null
+++ b/docs/README.md
@@ -0,0 +1,31 @@
+# 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.
diff --git a/docs/app/(home)/layout.tsx b/docs/app/(home)/layout.tsx
new file mode 100644
index 0000000..77379fa
--- /dev/null
+++ b/docs/app/(home)/layout.tsx
@@ -0,0 +1,6 @@
+import { HomeLayout } from 'fumadocs-ui/layouts/home';
+import { baseOptions } from '@/lib/layout.shared';
+
+export default function Layout({ children }: LayoutProps<'/'>) {
+ return {children} ;
+}
diff --git a/docs/app/(home)/page.tsx b/docs/app/(home)/page.tsx
new file mode 100644
index 0000000..2478c1e
--- /dev/null
+++ b/docs/app/(home)/page.tsx
@@ -0,0 +1,19 @@
+import Link from 'next/link';
+
+export default function HomePage() {
+ return (
+
+ ckanaction
+
+ You can open{' '}
+
+
+ );
+}
diff --git a/docs/app/api/search/route.ts b/docs/app/api/search/route.ts
new file mode 100644
index 0000000..7ba7e82
--- /dev/null
+++ b/docs/app/api/search/route.ts
@@ -0,0 +1,7 @@
+import { source } from '@/lib/source';
+import { createFromSource } from 'fumadocs-core/search/server';
+
+export const { GET } = createFromSource(source, {
+ // https://docs.orama.com/docs/orama-js/supported-languages
+ language: 'english',
+});
diff --git a/docs/app/docs/[[...slug]]/page.tsx b/docs/app/docs/[[...slug]]/page.tsx
new file mode 100644
index 0000000..9b6d208
--- /dev/null
+++ b/docs/app/docs/[[...slug]]/page.tsx
@@ -0,0 +1,54 @@
+import { getPageImage, source } from '@/lib/source';
+import {
+ DocsBody,
+ DocsDescription,
+ DocsPage,
+ DocsTitle,
+} from 'fumadocs-ui/page';
+import { notFound } from 'next/navigation';
+import { getMDXComponents } from '@/mdx-components';
+import type { Metadata } from 'next';
+import { createRelativeLink } from 'fumadocs-ui/mdx';
+
+export default async function Page(props: PageProps<'/docs/[[...slug]]'>) {
+ const params = await props.params;
+ const page = source.getPage(params.slug);
+ if (!page) notFound();
+
+ const MDX = page.data.body;
+
+ return (
+
+ {page.data.title}
+ {page.data.description}
+
+
+
+ );
+}
+
+export async function generateStaticParams() {
+ return source.generateParams();
+}
+
+export async function generateMetadata(
+ props: PageProps<'/docs/[[...slug]]'>,
+): Promise {
+ const params = await props.params;
+ const page = source.getPage(params.slug);
+ if (!page) notFound();
+
+ return {
+ title: page.data.title,
+ description: page.data.description,
+ openGraph: {
+ images: getPageImage(page).url,
+ },
+ };
+}
diff --git a/docs/app/docs/layout.tsx b/docs/app/docs/layout.tsx
new file mode 100644
index 0000000..8e9ec72
--- /dev/null
+++ b/docs/app/docs/layout.tsx
@@ -0,0 +1,11 @@
+import { DocsLayout } from 'fumadocs-ui/layouts/docs';
+import { baseOptions } from '@/lib/layout.shared';
+import { source } from '@/lib/source';
+
+export default function Layout({ children }: LayoutProps<'/docs'>) {
+ return (
+
+ {children}
+
+ );
+}
diff --git a/docs/app/global.css b/docs/app/global.css
new file mode 100644
index 0000000..7d105b7
--- /dev/null
+++ b/docs/app/global.css
@@ -0,0 +1,5 @@
+@import 'tailwindcss';
+@import 'fumadocs-ui/css/neutral.css';
+@import 'fumadocs-ui/css/preset.css';
+@import 'fumadocs-openapi/css/preset.css';
+
diff --git a/docs/app/layout.tsx b/docs/app/layout.tsx
new file mode 100644
index 0000000..6dde91d
--- /dev/null
+++ b/docs/app/layout.tsx
@@ -0,0 +1,26 @@
+import '@/app/global.css';
+import { RootProvider } from 'fumadocs-ui/provider/next';
+import { Inter } from 'next/font/google';
+import Script from "next/script";
+
+const inter = Inter({
+ subsets: ['latin'],
+});
+
+export default function Layout({ children }: LayoutProps<'/'>) {
+ return (
+
+
+ {children}
+
+
+
+ );
+}
diff --git a/docs/app/llms-full.txt/route.ts b/docs/app/llms-full.txt/route.ts
new file mode 100644
index 0000000..d494d2c
--- /dev/null
+++ b/docs/app/llms-full.txt/route.ts
@@ -0,0 +1,10 @@
+import { getLLMText, source } from '@/lib/source';
+
+export const revalidate = false;
+
+export async function GET() {
+ const scan = source.getPages().map(getLLMText);
+ const scanned = await Promise.all(scan);
+
+ return new Response(scanned.join('\n\n'));
+}
diff --git a/docs/app/og/docs/[...slug]/route.tsx b/docs/app/og/docs/[...slug]/route.tsx
new file mode 100644
index 0000000..878d338
--- /dev/null
+++ b/docs/app/og/docs/[...slug]/route.tsx
@@ -0,0 +1,36 @@
+import { getPageImage, source } from '@/lib/source';
+import { notFound } from 'next/navigation';
+import { ImageResponse } from 'next/og';
+import { generate as DefaultImage } from 'fumadocs-ui/og';
+
+export const revalidate = false;
+
+export async function GET(
+ _req: Request,
+ { params }: RouteContext<'/og/docs/[...slug]'>,
+) {
+ const { slug } = await params;
+ const page = source.getPage(slug.slice(0, -1));
+ if (!page) notFound();
+
+ return new ImageResponse(
+ (
+ > {
+ // Load environment variables from .env file
+ dotenv()?;
+
+ // Initialize and build CKAN struct
+ let ckan = ckanaction::CKAN::builder()
+ .url("http://localhost:5000")
+ .token(dotenvy::var("CKAN_API_TOKEN")?)
+ .build();
+
+ // Send request to /package_list and print output
+ let result = ckan.package_list()
+ .limit(5) // <-- This is an optional parameter you can remove
+ .call()
+ .await?;
+ println!("{result:#?}");
+
+ Ok(())
+}
+```
+
+The source code of ckanaction can be found at [github.com/dathere/ckanaction](https://github.com/ckanaction).
+
+You may also explore this web app to view more code examples for each endpoint and also use an interactive GUI for sending HTTP requests to any local or remote CKAN instance.
diff --git a/docs/content/docs/package_list.mdx b/docs/content/docs/package_list.mdx
new file mode 100644
index 0000000..80909bc
--- /dev/null
+++ b/docs/content/docs/package_list.mdx
@@ -0,0 +1,18 @@
+---
+title: /package_list
+full: true
+_openapi:
+ method: GET
+ route: /package_list
+ toc: []
+ structuredData:
+ headings: []
+ contents:
+ - content: This endpoint lists CKAN resources (limit 10).
+---
+
+{/* This file was generated by Fumadocs. Do not edit this file directly. Any changes should be made by running the generation command again. */}
+
+This endpoint lists CKAN resources (limit 10).
+
+> {
+ // Load environment variables from .env file
+ dotenv()?;
+
+ // Initialize and build CKAN struct
+ let ckan = ckanaction::CKAN::builder()
+ .url("http://localhost:5000")
+ .token(dotenvy::var("CKAN_API_TOKEN")?)
+ .build();
+
+ // Send request to /status_show and print output
+ let result = ckan.status_show().await?;
+ println!("{result:#?}");
+
+ Ok(())
+ }
+ '/package_list':
+ get:
+ operationId: /package_list
+ summary: /package_list
+ description: This endpoint lists CKAN resources (limit 10).
+ x-codeSamples:
+ - lang: rust
+ label: Rust SDK (ckanaction)
+ source: |
+ use dotenvy::dotenv;
+
+ #[tokio::main]
+ async fn main() -> Result<(), Box> {
+ // Load environment variables from .env file
+ dotenv()?;
+
+ // Initialize and build CKAN struct
+ let ckan = ckanaction::CKAN::builder()
+ .url("http://localhost:5000")
+ .token(dotenvy::var("CKAN_API_TOKEN")?)
+ .build();
+
+ // Send request to /package_list and print output
+ let result = ckan.package_list()
+ .limit(5) // <-- This is an optional parameter you can remove
+ .call()
+ .await?;
+ println!("{result:#?}");
+
+ Ok(())
+ }
\ No newline at end of file
diff --git a/docs/lib/source.ts b/docs/lib/source.ts
new file mode 100644
index 0000000..3bf329a
--- /dev/null
+++ b/docs/lib/source.ts
@@ -0,0 +1,28 @@
+import { docs } from '@/.source';
+import { type InferPageType, loader } from 'fumadocs-core/source';
+import { lucideIconsPlugin } from 'fumadocs-core/source/lucide-icons';
+import { openapiPlugin } from 'fumadocs-openapi/server';
+
+// See https://fumadocs.dev/docs/headless/source-api for more info
+export const source = loader({
+ baseUrl: '/docs',
+ source: docs.toFumadocsSource(),
+ plugins: [lucideIconsPlugin(), openapiPlugin()],
+});
+
+export function getPageImage(page: InferPageType) {
+ const segments = [...page.slugs, 'image.png'];
+
+ return {
+ segments,
+ url: `/og/docs/${segments.join('/')}`,
+ };
+}
+
+export async function getLLMText(page: InferPageType) {
+ const processed = await page.data.getText('processed');
+
+ return `# ${page.data.title} (${page.url})
+
+${processed}`;
+}
diff --git a/docs/mdx-components.tsx b/docs/mdx-components.tsx
new file mode 100644
index 0000000..f47f977
--- /dev/null
+++ b/docs/mdx-components.tsx
@@ -0,0 +1,13 @@
+import defaultMdxComponents from 'fumadocs-ui/mdx';
+import { APIPage } from 'fumadocs-openapi/ui';
+import { openapi } from '@/lib/openapi';
+import type { MDXComponents } from 'mdx/types';
+
+// use this function to get MDX components, you will need it for rendering MDX
+export function getMDXComponents(components?: MDXComponents): MDXComponents {
+ return {
+ ...defaultMdxComponents,
+ APIPage: (props) =>