Skip to content

Latest commit

 

History

History
34 lines (22 loc) · 1.29 KB

README.md

File metadata and controls

34 lines (22 loc) · 1.29 KB
Raw

ProxyToys Documentation

This repository contains the GitHub pages for ProxyToys that are used to render automatically the static website of ProxyToys.

Site Generation

The content of this repository is generated. ProxyToys uses Maven and XSite to generate the pages. To create an update of the site, you have to edit the sources in the ProxyToys repository.

Prerequisites

  • Java 5 runtime
  • Maven 3.0

Steps

  1. Create a clone of the current repository

  2. Create a clone of the proxytoys Git repository using the same base directory.

  3. Edit the sources in proxytoys.git/website/src/site/content

  4. From the root of proxytoys.git call

     mvn clean package

  5. Update the repository with the GitHub pages.

     rsync -cr --progress --delete --exclude=.nojekyll --exclude=.git* --exclude=*.md --exclude=jira --exclude=apidocs ./website/target/xsite/ ../proxytoys.io/

After Release

Typically you want to update the site after a ProxyToys release. In that case you can call:

rsync -cr --progress --delete --exclude=.nojekyll --exclude=.git* --exclude=*.md --exclude=jira ./target/checkout/website/target/xsite/ ../proxytoys.io/

Note, that this variant will also replace the javadocs.