Merge pull request #32 from no-witness-labs/feat/migrate-to-fumadocs

feat/migrate to fumadocs

Author: solidsnakedev

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

docs/README.md

@@ -0,0 +1,45 @@
+# docs
+
+This is a Next.js application generated with
+[Create Fumadocs](https://github.com/fuma-nama/fumadocs).
+
+Run development server:
+
+```bash
+npm run dev
+# or
+pnpm dev
+# or
+yarn 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()`](https://fumadocs.dev/docs/headless/source-api) 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.                          |
+
+### Fumadocs MDX
+
+A `source.config.ts` config file has been included, you can customise different options like frontmatter schema.
+
+Read the [Introduction](https://fumadocs.dev/docs/mdx) for further details.
+
+## Learn More
+
+To learn more about Next.js and Fumadocs, take a look at the following
+resources:
+
+- [Next.js Documentation](https://nextjs.org/docs) - learn about Next.js
+  features and API.
+- [Learn Next.js](https://nextjs.org/learn) - an interactive Next.js tutorial.
+- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs

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 <HomeLayout {...baseOptions()}>{children}</HomeLayout>
+}

docs/app/(home)/page.tsx

@@ -0,0 +1,6 @@
+import { redirect } from "next/navigation"
+
+export default function HomePage() {
+  // Permanently redirect root to /docs
+  redirect("/docs")
+}

docs/app/api/search/route.ts

@@ -0,0 +1,13 @@
+// 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',
+// });
+
+import { source } from "@/lib/source"
+import { createFromSource } from "fumadocs-core/search/server"
+// it should be cached forever
+export const revalidate = false
+export const { staticGET: GET } = createFromSource(source)

docs/app/docs/[[...slug]]/page.tsx

@@ -0,0 +1,44 @@
+import { source } from "@/lib/source"
+import { DocsBody, DocsDescription, DocsPage, DocsTitle } from "fumadocs-ui/page"
+import type { Metadata } from "next"
+import { notFound } from "next/navigation"
+import { createRelativeLink } from "fumadocs-ui/mdx"
+import { getMDXComponents } from "@/mdx-components"
+
+export default async function Page(props: PageProps<"/docs/[[...slug]]">) {
+  const params = await props.params
+  const page = source.getPage(params.slug)
+  if (!page) notFound()
+
+  const MDXContent = page.data.body
+
+  return (
+    <DocsPage toc={page.data.toc} full={page.data.full}>
+      <DocsTitle>{page.data.title}</DocsTitle>
+      <DocsDescription>{page.data.description}</DocsDescription>
+      <DocsBody>
+        <MDXContent
+          components={getMDXComponents({
+            // this allows you to link to other pages with relative file paths
+            a: createRelativeLink(source, page)
+          })}
+        />
+      </DocsBody>
+    </DocsPage>
+  )
+}
+
+export async function generateStaticParams() {
+  return source.generateParams()
+}
+
+export async function generateMetadata(props: PageProps<"/docs/[[...slug]]">): Promise<Metadata> {
+  const params = await props.params
+  const page = source.getPage(params.slug)
+  if (!page) notFound()
+
+  return {
+    title: page.data.title,
+    description: page.data.description
+  }
+}

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 (
+    <DocsLayout tree={source.pageTree} {...baseOptions()}>
+      {children}
+    </DocsLayout>
+  )
+}

docs/app/global.css

@@ -0,0 +1,3 @@
+@import 'tailwindcss';
+@import 'fumadocs-ui/css/neutral.css';
+@import 'fumadocs-ui/css/preset.css';

docs/app/layout.tsx

@@ -0,0 +1,17 @@
+import "@/app/global.css"
+import { RootProvider } from "fumadocs-ui/provider"
+import { Inter } from "next/font/google"
+
+const inter = Inter({
+  subsets: ["latin"]
+})
+
+export default function Layout({ children }: LayoutProps<"/">) {
+  return (
+    <html lang="en" className={inter.className} suppressHydrationWarning>
+      <body className="flex flex-col min-h-screen">
+        <RootProvider>{children}</RootProvider>
+      </body>
+    </html>
+  )
+}

docs/pages/getting-started/address.mdx …tting-started/address/address-format.mdxdocs/pages/getting-started/address.mdx renamed to docs/content/docs/getting-started/address/address-format.mdx docs/pages/getting-started/address.mdx renamed to docs/content/docs/getting-started/address/address-format.mdx

@@ -1,12 +1,11 @@
-# Address
-
-Address module provides functionality for working with address types in Cardano.
-
-## Address Example
-
-{/* BEGIN:snippet file=address.ts region=address-example lang=typescript */}
+---
+title: "Address Format"
+---
 
 ```typescript
+// Examples for Address getting-started page
+// Run with: pnpm -w -C docs ts-node examples/address.ts (or a small runner)
+
 // #region address-example
 import assert from "node:assert/strict"
 import { Address } from "@evolution-sdk/evolution"
@@ -22,10 +21,9 @@ const actualBech32 = Address.toBech32(address)
 
 // Verify the conversion is correct
 assert.strictEqual(actualBech32, expectedBech32)
-```
-
-{/* END:snippet */}
+// #endregion address-example
 
-## API Reference
-
-For detailed API documentation, see the generated TypeDoc documentation.
+if (import.meta.url === `file://${process.argv[1]}`) {
+  console.log("Address example OK")
+}
+```