IPF Documentation

This is a GitHub Pages project documenting the eHealth Integration Platform (IPF). The documentation is deployed on github at this location. The previous (obsolete) documentation can still be found here.

The layout is based on the Minimal Mistakes Theme (see description in README-minimal-mistakes.md).

Build remotely

There is nothing to be done. GitHub Pages are automatically rebuilt and redeployed after a commit. Make sure, however, that remote_theme property is enabled the theme property is disabled in _config.yml.

Build locally

In order to build and work locally,

• Follow these instructions. Hint: install/download the required ruby gems and jekyll plugin without using a proxy!
• For local site generation, comment out the remote_theme and enable the theme property in _config.yml.
• Run bundle exec jekyll serve
• The site is served on http://localhost:4000/ipf-docs

TO-DOs

• Javadocs not included yet
• Add description here on how/where to add or edit pages
• Add description on how to update the theme
• Links missing, some polishing