The OSV.dev docs are hosted on GitHub Pages.

You can run the docs locally consistently through docker. From the docs directory, run:

docker build -t osvdev-docs -f docs.Dockerfile .
docker run -p 4000:4000 osvdev-docs

To run the docs locally:

• Install ruby (>= 3.1.0). This should come with bundler.
  • On Debian, you need to install them separately:
    • ruby
    • ruby-bundler
• In this directory:
  • bundle install
  • bundle exec jekyll serve

Here's the full documentation on GitHub for running Jekyll locally.

Install protoc for your platform:

https://grpc.io/docs/protoc-installation/

Install clang for your platform:

https://releases.llvm.org/download.html

In the root directory, update submodules:

git submodule update --init --recursive

Install protoc-gen-openapiv2:

go install github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2@latest

To install the protobuf service converter, run:

go mod download

python3 ./build_swagger.py