The documentation for Gutenberg is a Jekyll site, hosted on GitHub Pages.
The docs site also includes Plausible analytics via the plausible block in docs/_config.yml and the theme hook at docs/_includes/head_custom.html.
To deploy a local version of the site you will need to:
- Install ruby.
- Install jekyll and bundler:
gem install jekyll bundler - Install the gems by navigating to the
docsdirectory and run:
bundle install - Run the site locally with:
bundle exec jekyll serve - Navigate to
localhost:4000in your browser to view the site.
From the repository root you can also use:
yarn docsto serve the site locallyyarn docs:buildto build the site intodocs/_site
Note: if you wish to use a page theme you will need to use remote-theme by uncommenting the remote-theme line in /docs/_config.yml and commenting out the theme line.