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.
f27e85e346
|
10 years ago | |
|---|---|---|
| .. | ||
| _static | ||
| oinkmaster | 10 years ago | |
| performance | 10 years ago | |
| rules | 10 years ago | |
| .gitignore | ||
| Makefile | ||
| README.md | ||
| command-line-options.rst | ||
| conf.py | 10 years ago | |
| convert.py | ||
| dropping-privileges.rst | ||
| index.rst | 10 years ago | |
| make-sense-alerts.rst | 10 years ago | |
| oinkmaster.rst | 10 years ago | |
| snort-compatibility.rst | 10 years ago | |
| 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.