https://github.com/nginx/unit-docs
NGINX Unit's official website and documentation
https://github.com/nginx/unit-docs
Last synced: about 1 year ago
JSON representation
NGINX Unit's official website and documentation
- Host: GitHub
- URL: https://github.com/nginx/unit-docs
- Owner: nginx
- License: cc-by-4.0
- Created: 2017-09-19T14:23:28.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2025-03-04T12:26:30.000Z (over 1 year ago)
- Last Synced: 2025-04-01T17:03:56.249Z (over 1 year ago)
- Language: Python
- Homepage: https://unit.nginx.org
- Size: 11.5 MB
- Stars: 54
- Watchers: 16
- Forks: 110
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# NGINX Unit Documentation
This is the source code for [NGINX Unit](https://github.com/nginx/unit/)'s
official website, written in
[reStructuredText](https://en.wikipedia.org/wiki/ReStructuredText) and built
with the [Sphinx](https://www.sphinx-doc.org/en/master/) generator.
## Development
To run a local version of the website:
```shell
git clone https://github.com/nginx/unit-docs && cd unit-docs
pip install -r requirements.txt
make serve
```
Commits in any branch associated with a Pull Request, if made by a maintainer, will automatically deploy a preview site. A comment with a link to the preview will show up in the PR.
## Deployment
See the [`docs-actions` README](https://github.com/nginxinc/docs-actions/tree/main?tab=readme-ov-file#docs-actions).
## Contributing
Pull requests are welcome. For major changes, please open an issue
first to discuss what you would like to change.
## License
The documentation for NGINX Unit is licensed under [CC BY 4.0](LICENSE).