https://github.com/fatfish-lab/aquarium-documentation
Aquarium documentation
https://github.com/fatfish-lab/aquarium-documentation
api aquarium documentation management project
Last synced: 4 months ago
JSON representation
Aquarium documentation
- Host: GitHub
- URL: https://github.com/fatfish-lab/aquarium-documentation
- Owner: fatfish-lab
- Created: 2024-07-16T13:32:23.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-11-20T18:15:56.000Z (7 months ago)
- Last Synced: 2025-11-20T20:15:05.654Z (7 months ago)
- Topics: api, aquarium, documentation, management, project
- Language: Bru
- Homepage: https://docs.aquarium.app
- Size: 10.6 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Aquarium documentation
This repository contains the documentations for [Aquarium](https://fatfi.sh/aquarium), a software developed by the [Fatfish Lab](https://fatfi.sh).
This documentation use [Lume](https://lume.land) to generate the static website. The content is written in Markdown. The REST API documentation is generated using [Bruno](https://www.usebruno.com)
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.
## Table of contents
All the content of the documentation is available in the [`src` folder](src). 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](screenshot/screenshot.ts). Refer to its dedicated [README](screenshot/README.md) 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`.
## Installation
1. Install [Deno](https://docs.deno.com/runtime/manual/#install-deno)
2. Run the dev server with: `deno task dev`