Skip to content

Latest commit

 

History

History
21 lines (13 loc) · 700 Bytes

README.md

File metadata and controls

21 lines (13 loc) · 700 Bytes

IRIS Documentation

The documentation is built with MkDocs Materials.

Installation

To install an environment in which you can build the doc, follow the steps below. The building step requires IRIS Client to be installed.

pip3 install mkdocs-material mkdocstrings mkdocs-git-revision-date-plugin mkdocs-awesome-pages-plugin
git clone [email protected]:dfir-iris/iris-doc-src.git
cd iris-doc-src/

# To preview the changes while writing 
mkdocs serve 

# To build 
mkdocs build

License

The contents of this repository is available under LGPL3 license.