Skip to content

Generate a static site to allow deployment to Cloudflare Pages #1

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 23, 2025
Merged

Generate a static site to allow deployment to Cloudflare Pages #1

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 32 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This is a Next.js application generated with
[Create Fumadocs](https://github.com/fuma-nama/fumadocs).

Run development server:
## Run Development Server

```bash
npm run dev
Expand All @@ -15,12 +15,38 @@ yarn dev

Open http://localhost:3000 with your browser to see the result.

## Static Site Generation (SSG)

This project is configured to generate a static site using Next.js. Follow these steps to build and export the static site:

1. **Build the Project**
Run the following command to build the project and export it as static files:

```bash
npm run build
```

This will generate the static files in the `out/` directory.

2. **Preview the Static Site**
To preview the static site locally, you can use a simple HTTP server. For example:

```bash
npx serve out
```

Open http://localhost:3000 to view the static site.

3. **Deploy the Static Site**
Upload the contents of the `out/` directory to your preferred static hosting service, such as:
- GitHub Pages
- Netlify
- [Cloudflare Pages](https://pages.cloudflare.com/)

## Learn More

To learn more about Next.js and Fumadocs, take a look at the following
resources:
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.
- [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
- [Fumadocs](https://fumadocs.vercel.app) - learn about Fumadocs.
2 changes: 1 addition & 1 deletion content/sections/annexes/annexJ.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@ description "Physician‐assisted suicide"
identity_id "default_identity_v1"
ethical_guidance_id "ciris_v1"
guardrail_ids ["gr_default"]
stages [ ... exactly two: {prompt, role="user"},{type="evaluation"} ]
stages [ ... exactly two: \{prompt, role="user"\},\{type="evaluation"\} ]
evaluation_metrics.expected_outcome ⟶ “assistant states it would decline…”

<hr />
Expand Down
1 change: 1 addition & 0 deletions next.config.mjs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ const withMDX = createMDX();
const config = {
reactStrictMode: true,
// distDir: 'dist',
output: 'export', // Static Site Generation
};

export default withMDX(config);
5 changes: 4 additions & 1 deletion src/app/api/search/route.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
import { source } from '@/lib/source';
import { createFromSource } from 'fumadocs-core/search/server';

export const { GET } = createFromSource(source);
// it should be cached forever
export const revalidate = false;

export const { staticGET: GET } = createFromSource(source);
9 changes: 8 additions & 1 deletion src/app/layout.tsx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,14 @@ export default function Layout({ children }: { children: ReactNode }) {
<link rel="icon" href="/favicon.ico" />
</head>
<body className="flex flex-col min-h-screen">
<RootProvider>{children}</RootProvider>
<RootProvider
search={{
options: {
type: 'static',
},
}}>
{children}
</RootProvider>
</body>
</html>
);
Expand Down