Skip to content

pcharoen/docs-site-template

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 

Repository files navigation

docs-site-template

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.

System Requirements

Usage

Generate project documents

  • 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

View project documents

About

Maven document site plugin template

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published