https://github.com/thehive-project/docs
Official documentation for TheHive Project applications
https://github.com/thehive-project/docs
Last synced: 9 months ago
JSON representation
Official documentation for TheHive Project applications
- Host: GitHub
- URL: https://github.com/thehive-project/docs
- Owner: TheHive-Project
- Created: 2021-02-20T06:46:44.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2023-09-29T10:40:21.000Z (almost 3 years ago)
- Last Synced: 2025-03-11T00:32:06.882Z (over 1 year ago)
- Language: HTML
- Homepage: https://docs.thehive-project.org
- Size: 47.2 MB
- Stars: 21
- Watchers: 6
- Forks: 33
- Open Issues: 14
-
Metadata Files:
- Readme: README.md
- Security: security.txt
Awesome Lists containing this project
README
# docs
The documentation uses mkdocs to render the content.
## Test changes
```bash
# Install the requirements first
pip install -r requirements.txt
# Start the mkdocs server in development mode
mkdocs serve
```
Alternatively you can use a docker container:
```bash
docker build . -t thehive-docs
docker run -it --rm -p 8000:8000 -v $PWD:/docs thehive-docs
```
## Deploy
After commiting changes in `main`branch, deploy the documentation by running this command:
```bash
mkdocs gh-deploy --remote-branch gh-pages
```