Developing Supabase Docs

Getting started

Thanks for your interest in Supabase docs and for wanting to contribute! Before you begin, read the code of conduct and check out the existing issues. This document describes how to set up your development environment to contribute to Supabase docs.

For a complete run-down on how all of our tools work together, see the main DEVELOPERS.md. That readme describes how to get set up locally in lots of detail, including minimum requirements, our Turborepo setup, installing packages, sharing components across projects, and more. This readme deals specifically with the docs site.

[!TIP] If you work at Supabase, branch this repo directly to make PRs. Don't use a fork. This lets the CI checks auto-run and speeds up review.

Local setup

supabase.com/docs is a Next.js site. You can get setup by following the same steps for all of our other Next.js projects:

1. Follow the steps outlined in the Local Development section of the main DEVELOPERS.md
2. If you work at Supabase, run dev:secrets:pull to pull down the internal environment variables. If you're a community member, create a .env file and add this line to it: NEXT_PUBLIC_IS_PLATFORM=false
3. Start the local docs site by navigating to /apps/docs and running npm run dev
4. Visit http://localhost:3001/docs in your browser - don't forget to append the /docs to the end
5. Your local site should look exactly like https://supabase.com/docs

AI friendly documentation

This project generates Markdown files for each page under /docs/guides/.. path.

To test locally, within the apps/docs directory:

1. Run pnpm build:guides-markdown
2. Run pnpm dev

This creates Markdown files for all routes under the public/docs/guides directory, ignored by Git.

For production this setup runs as a prebuild task to allow Vercel to bundle these files with middleware and functions.

Contributing

For repo organization and style guide, see the contributing guide.