weslambert / velociraptor-docs

Documentation site for Velociraptor

Documentation site for Velociraptor

This is the documentation site for Velociraptor - digging deeper!

Building this site

The site uses the static website generator Hugo.

To develop on the site:

1. clone this repository by running the following git clone command

   git clone --recurse-submodules https://github.com/Velocidex/velociraptor-docs.git
   

   Note normal cloning will not work. You must recurse the submodules or hugo will not understand shortcodes and you will see errors such as: failed to extract shortcode: template for shortcode "children" not found

2. Run Hugo:

   1. Run Hugo with a nativly installed version

   hugo serve
   

   2. Alternativly you can run hugo in docker as such:

   docker run --rm -it -v $(pwd):/src -p 1313:1313 klakegg/hugo:alpine
   

3. Open your browser to http://localhost:1313.

   This will bring up a local web server where you can see your changes.

Shield:

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.