amka/docs

Our docs site

Your production-grade backend from one file

Try it Out | Join our Discord

---

Documentation

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.

Getting Started

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.

Testing Broken Links

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.

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Tejas Kumar 📖 💻 ⚠️	Jay Meistrich 📖	Shedrack akintayo 📖	Dave New 📖	tomfrew 📖	Adam Bull 📖	Jon Bretman 📖 💻
David Blooman 📖	Jure 📖 💻	Emily Toop 📖	Louisa Spicer 📖	Andrew Lovett-Barron 📖	peterhoward42 📖
Add your contributions

This project follows the all-contributors specification. Contributions of any kind welcome!