diff --git a/docs/app/(home)/page.tsx b/docs/app/(home)/page.tsx index 2478c1e..93edb9e 100644 --- a/docs/app/(home)/page.tsx +++ b/docs/app/(home)/page.tsx @@ -1,19 +1,42 @@ -import Link from 'next/link'; +import Link from "next/link"; export default function HomePage() { return (

ckanaction

- You can open{' '} + You can open{" "} /docs - {' '} + {" "} and see the interactive documentation.

+
); } diff --git a/docs/app/docs/[[...slug]]/page.tsx b/docs/app/docs/[[...slug]]/page.tsx index 9b6d208..c77ecfd 100644 --- a/docs/app/docs/[[...slug]]/page.tsx +++ b/docs/app/docs/[[...slug]]/page.tsx @@ -1,23 +1,25 @@ -import { getPageImage, source } from '@/lib/source'; +import { createRelativeLink } from "fumadocs-ui/mdx"; 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'; +} from "fumadocs-ui/page"; +import type { Metadata } from "next"; +import { notFound } from "next/navigation"; +import { getPageImage, source } from "@/lib/source"; +import { getMDXComponents } from "@/mdx-components"; -export default async function Page(props: PageProps<'/docs/[[...slug]]'>) { +export default async function Page(props: PageProps<"/docs/[[...slug]]">) { const params = await props.params; const page = source.getPage(params.slug); if (!page) notFound(); + // @ts-expect-error const MDX = page.data.body; return ( + // @ts-expect-error {page.data.title} {page.data.description} @@ -38,7 +40,7 @@ export async function generateStaticParams() { } export async function generateMetadata( - props: PageProps<'/docs/[[...slug]]'>, + props: PageProps<"/docs/[[...slug]]">, ): Promise { const params = await props.params; const page = source.getPage(params.slug); diff --git a/docs/content/docs/index.mdx b/docs/content/docs/index.mdx index c8c0980..d5a3929 100644 --- a/docs/content/docs/index.mdx +++ b/docs/content/docs/index.mdx @@ -37,4 +37,6 @@ The source code of ckanaction can be found at [github.com/dathere/ckanaction](ht 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. +View the GIF below to see how to point to a specific CKAN API endpoint using the interactive GUI, which by default points to a local CKAN instance endpoint's URL. + ![ckanaction web app demo](/ckanaction-web-app-interactive-demo.gif) diff --git a/docs/content/docs/meta.json b/docs/content/docs/meta.json new file mode 100644 index 0000000..95f186c --- /dev/null +++ b/docs/content/docs/meta.json @@ -0,0 +1,12 @@ +{ + "pages": [ + "--- ---", + "index", + "---🎁 Interactive CKAN API GUI---", + "...", + "--- ---", + "[Source Code](https://github.com/dathere/ckanaction)", + "[Support and Feedback](https://support.dathere.com)", + "[Privacy Policy](https://dathere.com/privacy-policy/)" + ] +} \ No newline at end of file diff --git a/docs/lib/source.ts b/docs/lib/source.ts index fbb965f..2a8a382 100644 --- a/docs/lib/source.ts +++ b/docs/lib/source.ts @@ -7,6 +7,7 @@ import { docs } from "@/.source"; export const source = loader({ baseUrl: "/docs", source: docs.toFumadocsSource(), + // @ts-expect-error plugins: [lucideIconsPlugin(), openapiPlugin()], }); @@ -20,6 +21,7 @@ export function getPageImage(page: InferPageType) { } export async function getLLMText(page: InferPageType) { + // @ts-expect-error const processed = await page.data.getText("processed"); return `# ${page.data.title} (${page.url})