README.md

README

The OSV-Scanner docs are hosted on a GitHub page.

Running docs locally

To run docs locally, you will need Jekyll on your machine.

Here are other pre-requisites and instructions for running the docs locally.

Formatting docs

We use - Prettier to standardize the format of markdown and config files.

This requires node/npm to be installed.

Running the formatter

Run the following in the project directory:

./scripts/run_formatters.sh

Documentation theme

We are using the Just the Docs theme.