building.md

Building

This documentation is for building the guide locally. You can instead read the current guide here.

Building the site

Prerequisites

• Install Ruby.
• Install Bundler.

Installing packages

bundle install

Build once

bundle exec jekyll build

Build continuously

bundle exec jekyll serve

View the site at localhost:4000/rhcsa-open-guide/ in your browser.

Verify links

After building:

bundle exec htmlproofer --assume-extension ./_site

Linting files

Prerequisites

• Install Node 16.
• Install Yarn v1.

Installing packages

yarn install

Linting

yarn lint

Formatting

yarn format

Linting prose

Prerequisites

• Install Vale.

Linting

vale .