This repository contains the documentations for Aquarium, a software developed by the Fatfish Lab.
This documentation use Lume to generate the static website. The content is written in Markdown. The REST API documentation is generated using Bruno
You are free to contribute to this documentation by submitting a pull request. You can also clone this repository and generate the documentation locally and customize it to your needs.
All the content of the documentation is available in the src folder. It's organized in few main categories:
- Web: The web interface of Aquarium
- API: The API of Aquarium
- How-to: Guides on how to use Aquarium
- Integrations: Guides of the integrations available in Aquarium
A script is responsible to generate screenshots of the web interface of Aquarium. It's stored in the screenshot folder. Refer to its dedicated README for more information.
Another script is available to check all dead links in the documentation. To run it, use the command deno task 404. This script have one option available: --exclude to specify domains to exclude from the check. Example: deno task 404 --exclude google.com --exclude github.com.
- Install Deno
- Run the dev server with:
deno task dev