Skip to content

Latest commit

 

History

History
30 lines (19 loc) · 946 Bytes

README.md

File metadata and controls

30 lines (19 loc) · 946 Bytes

HST Content Version Utils

This project provides utilities to retrieve versioned, frozen node content using HST Content Beans.

Documentation (Local)

The documentation can be generated locally by this command:

$ mvn clean install
$ mvn clean site

The output is in the target/site/ directory by default. You can open target/site/index.html in a browser.

Documentation (GitHub Pages)

Documentation is available at https://bloomreach-forge.github.io/hst-content-version-utils/.

You can generate the GitHub pages only from master branch by this command:

$ mvn clean install
$ find docs -name "*.html" -exec rm {} \;
$ mvn -Pgithub.pages clean site

The output is in the docs/ directory by default. You can open docs/index.html in a browser.

You can push it and GitHub Pages will be served for the site automatically.