Skip to content

How to manage the webside

Alexander Stanik edited this page Apr 21, 2015 · 1 revision

The overall webside is generated automatically.

Create new content

In the base directory of the project, navigate to

src/site/apt

There, create a file

<topic>.apt

and add your content.

Format your code with assistence by the description of the APT file format.

When maven converts your code to a HTML page, it will be available via <topic>.html. This page can be linked to from out a text or a menu.

To link the new page form out a menu, open the file

src/site/site.xml

Search for a <menu /> tag, where the new page fits or create a new <menu /> tag, and add a <item /> tag to it (according to http://maven.apache.org/doxia/doxia-sitetools/doxia-decoration-model/decoration.html).

Generate the webside

Run

mvn site

and the generated webside can be found in

target/site/

Make the webside public

The webside is made public manually through the gh-pages branch. You can find more information here.

In order to push the branch to github, please run

git push origin gh-pages

Clone this wiki locally