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.

Contributing to the docs

Documentation contributions are welcome!

See CONTRIBUTING.md for contribution guidelines.

Documentation theme

We are using the Just the Docs theme.