https://github.com/zammad/zammad-documentation
The system administrator documentation for Zammad.
https://github.com/zammad/zammad-documentation
documentation system zammad
Last synced: 4 days ago
JSON representation
The system administrator documentation for Zammad.
- Host: GitHub
- URL: https://github.com/zammad/zammad-documentation
- Owner: zammad
- License: agpl-3.0
- Created: 2016-11-09T14:50:46.000Z (over 9 years ago)
- Default Branch: pre-release
- Last Pushed: 2025-02-20T07:28:48.000Z (about 1 year ago)
- Last Synced: 2025-02-25T11:49:02.875Z (12 months ago)
- Topics: documentation, system, zammad
- Language: Makefile
- Homepage: https://docs.zammad.org
- Size: 28 MB
- Stars: 56
- Watchers: 15
- Forks: 125
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: contributing/start.rst
- License: LICENSE
Awesome Lists containing this project
README
[](https://docs.zammad.org/en/pre-release/?badge=pre-release) (pre-release)
[](https://docs.zammad.org/en/latest/?badge=latest) (latest)
# Zammad Documentation
Source files for [Zammad’s documentation](https://docs.zammad.org/en/latest/).
## Contributing
Please see [the Contributing section in this manual](https://docs.zammad.org/en/latest/contributing/start.html).
## Compilation
### Dependencies
Either install the dependencies on your machine or use a devcontainer, see next section.
* sphinx
```
$ pip install -r requirements.txt
```
### Devcontainer
If you can't or don't want to install the dependencies on your system, you can use a devcontainer. The repo
is prepared so you just need a supported editor (e.g. VS Code) and a Docker installation on your system.
Simply open the cloned repo in a supported editor and it should ask you to open the folder in a container. After it got
set up, you can compile the docs with your changes locally.
For more information, check these resources:
- https://github.com/devcontainers/
- https://containers.dev/
### Example for a local HTML build
```
make html
```