An open API service indexing awesome lists of open source software.

https://github.com/nginx/documentation

Public source for docs.nginx.com
https://github.com/nginx/documentation

documentation nginx

Last synced: 9 months ago
JSON representation

Public source for docs.nginx.com

Awesome Lists containing this project

README

          

[![OpenSSF Scorecard](https://api.securityscorecards.dev/projects/github.com/nginxinc/template-repository/badge)](https://securityscorecards.dev/viewer/?uri=github.com/nginxinc/template-repository)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Community Support](https://badgen.net/badge/support/community/cyan?icon=awesome)](https://github.com/nginxinc/template-repository/blob/main/SUPPORT.md)
[![Contributor Covenant](https://img.shields.io/badge/Contributor%20Covenant-2.1-4baaaa.svg)](https://github.com/nginxinc/template-repository/main/CODE_OF_CONDUCT.md)
![Commercial Support](https://badgen.net/badge/support/commercial/green?icon=awesome)

# NGINX documentation

If you want to contribute to [F5 NGINX documentation](https://docs.nginx.com), you've come to the right place. We've organized a series of README-type files to help you get started:

- [Contributing](/CONTRIBUTING.md) describes how you can contribute to our documentation.
- [Contributing guidelines for experts](/CONTRIBUTING_DOCS.md) describes how you can contribute (and check your work) with Hugo, our static site generator
- [Code of Conduct](/CODE_OF_CONDUCT.md) describes expectations in the NGINX open source community.
- [License](/LICENSE) shows the license associated with work on this repository.
- [Security](/SECURITY.md) describes the procedures we would like you to follow if you find a security issue.
- [Support](/SUPPORT.md) lists how you can get support as a customer or a community member.

## Explanation

This repository contains user documentation for NGINX's products, as well as the requirements for linting, building, and publishing the documentation.

Our documentation is written in Markdown, specifically the [Goldmark](https://github.com/yuin/goldmark) Markdown parser.
We build our docs using [Hugo](https://gohugo.io) and host them in custom URLs on Azure.

## License

[BSD 2-Clause "Simplified" License](/LICENSE)

© [F5, Inc.](https://www.f5.com/) 2025

## Credits

- [The Good Docs Project](https://www.thegooddocsproject.dev/), whose templates we've adapted for our use.