matonny/docs

Knock documentation

Knockumentation (docs)

Documentation, guides, and the API reference for Knock. Built with Next.JS and Typescript.

Getting up-and-running

System requirements

To run docs you will need:

• node & yarn (see .tool-versions)

Running docs

1. Install the necessary dependencies:

$ ./bin/bootstrap.sh

2. Start docs in development mode

$ yarn run dev

3. Open your browser to http://localhost:3002

Contributing

Contributions are welcome! There are several ways to contribute including:

1. Fixing typos and errors
2. Adding new content
3. Improving existing content
4. Providing feedback

The docs content can be found in the /content directory. Our documentation is written in MDX, a markdown format that supports embedding React components. See the GitHub Markdown Guide for a quick overview of markdown.

If you're new to GitHub, check out the Open Source Guide to learn how to fork a repository, create a branch, and submit a pull request.