Wavefront Documentation

Install Required Software

1. Follow the instructions to install Jekyll.
2. cd to the repository directory and run the following commands:

   $ cd docs
   $ sudo gem install bundler
   $ bundle install

3. Stay in the repository directory and clone the required submodules (which basically include the README.md of Wavefront public repositories into the official documentation)

   $ git submodule init
   $ git submodule update

Run and View Site Locally

Note: If you are on an Apple M1 silicon laptop, run the bundle config build.nokogiri --use-system-libraries command before following the below steps.

1. Run Jekyll with the following command:

   $ bundle exec jekyll server --incremental

2. Go to url http://localhost:4000/. The host and port are set in _config.yml.