Skip to content

Instantly share code, notes, and snippets.

@axeal

axeal/gist:db25a4f8d28c4dbe1c9bfeaf5ec8e95f

Last active February 4, 2026 13:04
Show Gist options

  • Select an option

    Learn more about clone URLs
  • Save axeal/db25a4f8d28c4dbe1c9bfeaf5ec8e95f to your computer and use it in GitHub Desktop.

Select an option

Learn more about clone URLs
Save axeal/db25a4f8d28c4dbe1c9bfeaf5ec8e95f to your computer and use it in GitHub Desktop.
Download ZIP
Run SUSE Product Docs
Raw
gistfile1.md

Requirements:

  • Node

Process

  1. Fork the repository
  2. Clone your fork including submodules git clone –recusive-submodules

    N.B. If you don’t clone the submodules, when you run make local you will get an error similar to [15:57:41.334] FATAL (antora): Cannot find module '/Users/alexseymour/git/rancher-product-docs/product-docs-common/extensions/dynamic-loading-attributes/load-global-site-attributes.js' in this instance you can clone the submodules from within the working directory with git submodule update --init --recursive

  3. Run make environment to install required dependencies
  4. Run make local to build the site locally into build/site. Open build/site/index.html to view.
  5. Run make preview to run a local http server serving the site on port 8080

The preview serves the content from build/site. It is not dynamic, so if you make a change to a file, you need to run make local again.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment