Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.89 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.89 KB
Raw

cityEHR Documentation

Build Status License

This respository contains the documentation for cityEHR. The documentation is authored in LwDITA XDITA format.

When the source code of a document is updated in GitHub, we use GitHub Actions to automatically render a new HTML and PDF version of the documentation.

Documents

Title Source Location Renderings
Quick Start Guide cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular HTML / PDF

Developing the Documentation

If you wish to build the documentation on your own computer, you will need the following tools installed:

  1. If you have not already done so, clone the respoistory:
$ git clone https://github.com/cityehr/cityehr-documentation.git
  1. Enter the clone folder:
$ cd cityehr-documentation
  1. Run the following command to have Maven (mvn) render a new PDF and HTML version of the documentation:
$ mvn clean package -Pquick-start-guide-website

You can find the rendered versions of the documentation in the target/ sub-folder of each module. For example:

  • cityehr-quick-start-guide/target/quickstart-guide.pdf
  • cityehr-quick-start-guide/target/website/index.html