Your production-grade backend from one file
This repo contains the documentation for Keel. It is a Next.js site built with the pages router. Every .mdx
file in the pages directory represents a page in the docs.
Since this is just another Next.js project, you can get started by cloning the repo and running npm install
to install the dependencies. Then, you can run npm run dev
to start the development server.
We make sure there are no broken links in these docs using Vitest. To run the link test (and other tests), run
npm run test
Vitest also runs on every PR branch, so you can check the status of the docs link test in the GitHub Actions tab, and take advantage of its --watch
mode during local development.
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!