Fork this page on GitHub

Scalate Site

How the website works

How it works

The Scalate documentation and site is created using Scalate and is stored in git in the same source control system as the code

Note: For code highlighting you will need to install http://pygments.org/.

Editing the source code

If you grab the source code you can get the site source in the scalate-website directory. If you have Scalate installed then you can build the website from the code as follows

cd scalate-website
mvn install

If you want to edit the files in your text editor and be able to immediately see the site re-rendered in a browser then use

mvn jetty:run

You can now surf the site and see changes immediately.

If you are on OS X then we highly recommend TextMate as a great editor which supports Textile and Markdown

Deploying the site

The site is automatically deployed by the CI builds, so you can simply wait for the changes to be automatically pushed to the project site.

You can manually deploy the site using Maven:

mvn scalate:deploy

Though website deployment also occurs by default using the deploy goal in maven

You will need to add the Scalate project's Web server to your Maven configuration:

<server>
  <id>website.fusesource.org</id>
  <username>xxxx</username>
  <password>xxxxx</password>
</server>