Update docs to auto-expand the TOC trees

git-svn-id: https://svn.apache.org/repos/asf/servicemix/documentation/branches/servicemix-4.5.x@1507349 13f79535-47bb-0310-9956-ffa450edef68
1 file changed
tree: fe74d5f571814a6a548b60f2ef55568b9580a52a
  1. .gitignore
  2. README.md
  3. pom.xml
  4. src/
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