README.md

Documentation

The official API documentation for serve.sh

Coming soon!

Support

If you need help with this API, do not hesitate to get in contact with us!

• For questions and high-level discussions, use Discussions on GitHub (Coming soon!)
• To report a bug or make a feature request, open an Issue.
• For anything else, our small but growing Discord community is visited by our team and other users. Join us to connect, share ideas, and get community support!

Contributing

In order to contribute to the documentation, it will be helpful to serve your changes locally so you can preview your edits in real-time.

Prerequisites

• Python 3
• pip
• mkdocs

Installation

First, install the dependencies:

python -m venv venv
source venv/bin/activate
pip install -r requirements.txt

Then, run the following command to start the local server:

mkdocs serve

You should see output like the following:

INFO    -  Documentation built in 0.30 seconds
INFO    -  [14:10:45] Watching paths for changes: 'docs', 'mkdocs.yml'
INFO    -  [14:10:45] Serving on http://127.0.0.1:8000/

This will start a local server at http://localhost:8000 where you can preview your changes.