Skip to content

Repository files navigation

mosoo-docs

This is a Next.js application generated with Create Fumadocs.

It is a Next.js app with Static Export configured.

Run development server:

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() 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 for further details.

Deployment

Pushes to main are linted, type-checked, built, and deployed to the mosoo-docs Cloudflare Worker by GitHub Actions. The GitHub production environment requires a CLOUDFLARE_ACCOUNT_ID variable and a scoped CLOUDFLARE_API_TOKEN secret. Create the token from Cloudflare's Edit Cloudflare Workers template, restricted to the production account and mosoo.ai zone.

For a manual deployment:

npm run deploy

Learn More

To learn more about Next.js and Fumadocs, take a look at the following resources:

About

Mosoo API documentation

Resources

Code of conduct

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages