amka / docs

Our docs site

Home Page:https://docs.keel.so

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Keel

Your production-grade backend from one file

Try it Out | Join our Discord


All Contributors

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
Tejas Kumar

πŸ“– πŸ’» ⚠️
Jay Meistrich
Jay Meistrich

πŸ“–
Shedrack akintayo
Shedrack akintayo

πŸ“–
Dave New
Dave New

πŸ“–
tomfrew
tomfrew

πŸ“–
Adam Bull
Adam Bull

πŸ“–
Jon Bretman
Jon Bretman

πŸ“– πŸ’»
David Blooman
David Blooman

πŸ“–
Jure
Jure

πŸ“– πŸ’»
Emily Toop
Emily Toop

πŸ“–
Louisa Spicer
Louisa Spicer

πŸ“–
Andrew Lovett-Barron
Andrew Lovett-Barron

πŸ“–
peterhoward42
peterhoward42

πŸ“–
Add your contributions

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

About

Our docs site

https://docs.keel.so

License:MIT License


Languages

Language:MDX 96.5%Language:TypeScript 3.3%Language:JavaScript 0.3%