This repository contains the website for the OWASP CRS Project.
The generated website is automatically updated at https://coreruleset.org/. If you intend to contribute to the website, the rest of this page will guide you through it.
You can edit the documentation on your local system. You will need is the latest Hugo binary for your OS (Windows, Linux, Mac), and a working NodeJS compiler (required by the theme we use).
Important: You need a modern version of Hugo, extended version >= 0.123.0.
After getting hugo, just clone this repository to work locally. This way you can edit and verify quickly that everything is working properly before creating a new pull request.
To clone, use the recursive option so you will be getting also the theme to render the pages properly:
git clone --recursive git@github.com:coreruleset/website.gitWe use two subrepos:
- the theme
- the documentation subrepo, which is built with a different theme
If you just want to edit documentation (not the website), you can do it in the documentation repo
You will need:
- hugo binary
- nodejs (for generating css files)
Then do:
❯ npm install
added 205 packages, and audited 206 packages in 13s
57 packages are looking for funding
run `npm fund` for details
found 0 vulnerabilitiesNow you have all in place to perform your local edits.
Everything is created using markdown, and you will normally use the content subdirectory to add your edits.
The theme has shortcodes that can be used to simplify editing. You can get more information about it on Hugo Dot-Org theme.
You can run hugo to serve the pages, and while you edit and save, your changes will be refreshed in the browser!
Use:
hugo serve
Then check your edits on http://localhost:1313/.
Any merged updates are pushed to coreruleset.github.io for preview.
Because users are git users now (there is no user "logged"), there is a mapping between authors and github users. If you want to collaborate, please add your github username as the key, and your data below. See the examples in that file.
Once you are happy with your local changes, please send a PR.
All illustrations are coming from https://undraw.co/, unless explicitly noted. See their license.
All images, assets and vectors published on unDraw can be used for free. You can use them for noncommercial and commercial purposes. You do not need to ask permission from or provide credit to the creator or unDraw. Thanks to Katerina Limpitsouni for her work 🙏
Favicons were generated using https://realfavicongenerator.net.
Check the hugo reference for the list of supported emojis!