mirror of
https://github.com/aliasvault/aliasvault.git
synced 2026-03-20 07:39:07 -04:00
15 lines
947 B
Markdown
15 lines
947 B
Markdown
# Contributing to the source code
|
|
We welcome contributions to AliasVault. Please read the guidelines on the official AliasVault docs website on how to get your local development environment setup and the general contribution guidelines:
|
|
|
|
https://docs.aliasvault.net/misc/dev/
|
|
|
|
> Tip: if the URL above is not available, the raw doc pages can also be found in the `docs` folder in this repository.
|
|
|
|
## Contributing to the documentation
|
|
The docs are built using Jekyll and automatically deploy to GitHub Pages via GitHub Actions. You can build the docs locally by running `docker compose up` in in the `./docs` folder.
|
|
|
|
The docs site is based on the open-source template called Just The Docs. Find more information about how this template works in the [official docs](https://just-the-docs.github.io/just-the-docs/).
|
|
|
|
|
|
To make changes to the AliasVault documentation please make a PR that directly edits the `docs` markdown files in this repository.
|