Skip to content

Website

Yannick Le Goc edited this page Oct 9, 2021 · 3 revisions

Principle

The website generation is organized as follows. There is a specific EVL website project that is not inside the EVL main project.
The website is a hugo static website based on the docsy theme.

The website is managed like this:

  • The website pages are generated using hugo from the sources.
  • The pages are copied into the EVL main project docs directory so that they become github pages at the next push.
  • The Javadoc pages generated in the EVL project by maven are copied into the EVL project docs/apidocs directory so that they become github pages.

Concretely if the website must be updated, go to the EVL website project directory and run deploy.sh with the EVL project directory, e.g.:

$ ./deploy.sh ../evl

Then you can commit and push the EVL project and the github pages will be automatically regenerated.

New EVL version

Do not forget to update the website before creating a release to the EVL project.

Clone this wiki locally