Skip to main content

Introduction

Prerequisites​

This documentation site is built with Docusaurus. To run the site locally for development and testing, ensure Node.js (v20.0 or above) and Yarn are installed.

Running locally​

  1. Navigate to the website/ directory and run yarn install to install all the required dependencies.

  2. Next, to run the site locally, run yarn start.

  3. This will start a local server on port 3000. You can view the site at http://localhost:3000.

Whilst yarn start is running, any changes made to the documentation will be published to the local instance automatically, allowing for a fast feedback loop as you make updates.

Running an old version​

If you want to see old versions of the docs (from before our migration to Docusaurus in 2025), we provided regular Docker images of the old documentation site on GHCR (previously on Docker Hub).

These images are not suitable for development, but are useful if you are working with an old HHVM/Hack version.

  1. Install Docker.
  2. Start a container with: docker run -p 8080:80 -d ghcr.io/hhvm/user-documentation.
  3. You can then access a local copy of the documentation at http://localhost:8080.