X Tutup
Skip to content

Latest commit

 

History

History
 
 

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
 
 
 
 
 
 

README.md

This module contains source of the Bootique documentation published on the website. The docs are in Docbook XML format.

Publishing Prerequisites

Checkout the web site:

# going to the parent of <main_bootique_checkout>
cd <main_bootique_checkout>/../

# checkout a second copy of Bootique to be able to copy stuff between the branches
git clone git@github.com:nhl/bootique.git bootique-pages 

# get on the website branch
git checkout -b gh-pages origin/gh-pages

Building the Docs

cd <main_bootique_checkout>/bootique-docs
mvn clean package

You can now inspect the local docs under target/site/index/.

Publishing the Docs

Build the docs locally as described above, and then do this:

cd <main_bootique_checkout>/bootique-docs
cp -r target/site/ ../../bootique-pages/docs/0/
cd ../../bootique-pages/docs/ 
git add -A
git commit -m "docs update"
git push

In a few seconds you will be able to check the result at http://bootique.io/docs/ .

X Tutup