https://github.com/apache/servicemix-documentation
Mirror of Apache ServiceMix Documentation
https://github.com/apache/servicemix-documentation
java network-client network-server osgi scala servicemix xml
Last synced: 6 months ago
JSON representation
Mirror of Apache ServiceMix Documentation
- Host: GitHub
- URL: https://github.com/apache/servicemix-documentation
- Owner: apache
- Created: 2010-10-19T07:00:23.000Z (almost 15 years ago)
- Default Branch: trunk
- Last Pushed: 2023-04-14T17:50:00.000Z (over 2 years ago)
- Last Synced: 2025-04-03T04:17:06.465Z (6 months ago)
- Topics: java, network-client, network-server, osgi, scala, servicemix, xml
- Language: JavaScript
- Size: 2.04 MB
- Stars: 13
- Watchers: 2
- Forks: 8
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
## Prerequisites ##
You need to have these two programs installed on your machine:
- [Pygments](http://pygments.org/) - syntax highlighting for HTML and PDF
- [Prince XML](http://www.princexml.com/) - 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](http://localhost:8080). 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