https://github.com/evolvedbinary/xdita-sample
https://github.com/evolvedbinary/xdita-sample
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/evolvedbinary/xdita-sample
- Owner: evolvedbinary
- Created: 2024-10-16T08:50:48.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-20T16:24:12.000Z (over 1 year ago)
- Last Synced: 2025-08-30T05:41:53.412Z (10 months ago)
- Language: XSLT
- Size: 24.5 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# cityEHR Documentation
[](https://github.com/cityehr/cityehr-documentation/actions/workflows/ci.yml)
[](https://creativecommons.org/licenses/by-nc-sa/4.0/)
This respository contains the documentation for cityEHR. The documentation is authored in [LwDITA](https://dita-lang.org/lwdita/capabilities/capabilities) 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](cityehr-quick-start-guide/src/main/lwdita/quickstart-guide-modular) | [HTML](https://cityehr.github.io/cityehr-documentation/) / [PDF](https://cityehr.github.io/cityehr-documentation/quickstart-guide.pdf) |
## Developing the Documentation
If you wish to build the documentation on your own computer, you will need the following tools installed:
* [Git](https://git-scm.com/)
* [Java JDK](https://bell-sw.com/pages/downloads/) version 8 (or newer)
* [Apache Maven](https://maven.apache.org/) 3.6 (or newer)
1. If you have not already done so, clone the respoistory:
```bash
$ git clone https://github.com/cityehr/cityehr-documentation.git
```
2. Enter the clone folder:
```bash
$ cd cityehr-documentation
```
3. Run the following command to have Maven (mvn) render a new PDF and HTML version of the documentation:
```bash
$ 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`