mirror of https://github.com/OISF/suricata
You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
a52aacb4ea
In some chapters of the rules documentation, many sections used examples of rules, but these were inserted into images. These have been replaced by text and HTML emphasis. Additionally, some tables embedded into images were also replaced by reST tables. |
7 years ago | |
|---|---|---|
| .. | ||
| _static | ||
| capture-hardware | ||
| configuration | ||
| file-extraction | ||
| licenses | ||
| manpages | ||
| output | ||
| partials | ||
| performance | ||
| reputation | ||
| rule-management | ||
| rules | 7 years ago | |
| setting-up-ipsinline-for-linux | ||
| .gitignore | ||
| Makefile.am | ||
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | ||
| convert.py | ||
| index.rst | ||
| initscripts.rst | ||
| install.rst | ||
| make-sense-alerts.rst | ||
| public-data-sets.rst | ||
| setting-up-ipsinline-for-linux.rst | ||
| unix-socket.rst | ||
| what-is-suricata.rst | ||
README.md
Suricata User Guide
This directory contains the Suricata Guide. The Sphinx Document Generate is used to build the documentation. For a primer os reStructuredText see the reStructuredText Primer.
Development Server
To help with writing documentation there is a development web server with live reload. To get run the live server you will first need npm installed then run the following:
npm install
gulp serve
Then point your browser at http://localhost:8000/_build/html/index.html
Any edits to .rst files should trigger a "make html" and cause your browser to refresh.