Skip to content

Files

Latest commit

dd7f1ae · Nov 22, 2024

History

History

www

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
Aug 30, 2024
Jul 24, 2024
Nov 22, 2024
Nov 1, 2024

VAST WWW

This contains the source code for https://trailofbits.github.io/vast/ ; which is rendered from the gh-pages branch of the same repo using GitHub pages.

To contribute, feel free to fork this repository and send a pull-request.

The website is deployed on every release of this repository using a GitHub action defined in .github/workflows/prerelease.yml. It also runs every release of VAST, which is used for generating some docs.

We are using the MkDocs framework for generating the website.

The expected workflow is to download mkdocs on your machine, and run mkdocs serve from the root directory. You can then access a local version of the website from http://127.0.0.1:8000/ ; any change you make to the source Markdown will automatically be refreshed by the local mkdocs server.

A large part of the documentation is auto-generated from the VAST source code. See the workflow .github/workflows/prerelease.yml for the instructions to reproduce the entirety of https://trailofbits.github.io/vast/ locally.