Skip to content

Repository files navigation

Paygate Docs

Documentation site for Paygate — a portfolio payment gateway. Built with Fumadocs.

Live: https://paygate-docs.vercel.app
API: https://paygate-api.fly.dev
Dashboard: https://paygate-dashboard.vercel.app


Content

Page Path
Quickstart content/docs/quickstart.mdx
Authentication content/docs/authentication.mdx
Charges content/docs/charges.mdx
Refunds content/docs/refunds.mdx
Webhooks content/docs/webhooks.mdx
Entity IDs content/docs/entity-ids.mdx
Errors content/docs/errors.mdx

Stack

Framework Next.js 15 (App Router)
Docs engine Fumadocs v16 + fumadocs-mdx v14
Styling Tailwind CSS v4
Deployment Vercel

Local Setup

Requirements: Node.js 20+

git clone https://github.com/MahmoudBakr23/paygate-docs
cd paygate-docs

npm install

Create .env.local:

NEXT_PUBLIC_API_URL=https://paygate-api.fly.dev
npm run dev

Open http://localhost:3000.


Adding Content

  1. Create a new .mdx file under content/docs/
  2. Add frontmatter: title, description
  3. Run npx fumadocs-mdx to regenerate .source/ (CI does this automatically)
  4. Add the page to app/source.ts if needed

The .source/ directory is gitignored — it is generated at build time by the CI job and next build.


Build

npx fumadocs-mdx   # regenerate .source/
npm run build

Deployment (Vercel)

CI deploys automatically on push to dev via .github/workflows/ci.yml.

About

Payment gateway API documentation — Fumadocs

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages