Google Git
Sign in
apache / servicemix-documentation / refs/heads/servicemix-4.4.x
commit627acff79efb60e29e8a0e823caa3f891dc5a219[log] [tgz]
authorGert Vanthienen <gertv@apache.org>Fri Feb 22 09:27:47 2013 +0000
committerGert Vanthienen <gertv@apache.org>Fri Feb 22 09:27:47 2013 +0000
tree16437933cfd69acb5de5b9714d422921ecbbde24
parent4f621543e9704ec4019a9dc126eee232de4846f7 [diff]
Update the README.md file

git-svn-id: https://svn.apache.org/repos/asf/servicemix/documentation/branches/servicemix-4.4.x@1448959 13f79535-47bb-0310-9956-ffa450edef68
1 file changed
tree: 16437933cfd69acb5de5b9714d422921ecbbde24
  1. src/
  2. .gitignore
  3. pom.xml
  4. README.md
README.md

Prerequisites

You need to have these two programs installed on your machine:

  • Pygments - syntax highlighting for HTML and PDF
  • Prince XML - converts HTML into PDF for the manual

Building the documentation project

There are two ways of building the documentation project:

  • mvn -Plive jetty:run will make a live website copy available locally. This is very convenient while editing the docs to quickly review the changes you made.
  • mvn clean install will build the documentation project, creating 3 representations:
    • a war file containing the documentation webapp
    • a pdf file (in target/sitegen/manual.pdf)
    • a static website, generated using the same templates (in target/sitegen)

Publishing the documentation to the website

If you're an Apache ServiceMix committer, you can publish a new copy of the documentation pages with this command: mvn clean install scm-publish:publish-scm

Known issues

  • The war file currently can't be deployed on ServiceMix