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.
c51ff32adb
|
7 years ago | |
|---|---|---|
| .. | ||
| _static | ||
| capture-hardware | ||
| configuration | 7 years ago | |
| file-extraction | 7 years ago | |
| licenses | ||
| lua | 7 years ago | |
| manpages | ||
| output | 7 years ago | |
| partials | 7 years ago | |
| performance | ||
| reputation | ||
| rule-management | 7 years ago | |
| rules | 7 years ago | |
| setting-up-ipsinline-for-linux | ||
| .gitignore | ||
| Makefile.am | 7 years ago | |
| Makefile.sphinx | ||
| README.md | ||
| acknowledgements.rst | ||
| command-line-options.rst | ||
| conf.py | ||
| convert.py | ||
| index.rst | 7 years ago | |
| initscripts.rst | ||
| install.rst | ||
| make-sense-alerts.rst | 7 years ago | |
| public-data-sets.rst | ||
| setting-up-ipsinline-for-linux.rst | ||
| unix-socket.rst | 7 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.