The docs-site-template is a project template for project documents site generator. It uses Apache Maven Site Plugin to generate a project document site. The site can be configured with a simple site.xml configuration. The documents can be written in markdown syntax. It uses Apache Maven site plugin with Fluido Skin built on top of [Twitter's Bootstrap 2.2.2] (http://bootstrapdocs.com/v2.2.2/docs/) web front end framework. The generated site can be deployed on Github project gh-pages branch or any web server. Click here to see a sample site.
- Java 6 http://www.oracle.com/technetwork/java/javase/overview/index.html
- Apache Maven 3 http://maven.apache.org/
- Git http://git-scm.com/
- create branch gh-pages on your project repository
- clone gh-pages branch
$ git clone https://github.com/ualbertalib/${project.name}.git -b gh-pages ${project.docs.dir}
- clone docs-site-template project
$ git clone https://github.com/ualbertalib/docs-site-template.git ${docs.site.template.dir}
- edit your documents in
${basedir}/src/site/markdown
directory
$ cd ${docs.site.template.dir}
- generate project documents
$ mvn site -Dsite.output.dir=${project.docs.dir}
- commit and push to gh-pages branch
$ git add .
$ git commit -m "Update project documents"
$ git push
- Point your browser to https://ualbertalib.github.io/${project.name}