This repository contains the official documentation for the eXist-db native XML database and the application for browsing it. You can browse the latest release of the documentation on eXist-db homepage. User reporting errors should check the contributions section below. Core-contributors preparing a release should consult the release procedure
- The default eXist-db installer includes the documentation app. Just go to your eXist server's Dashboard and select Documentation.
- If you need to install an older version, you can download EXPath Application Packages (
.xar
files) of previous releases from GitHub. - Update to the latest release via the eXist-db package manager or via the eXist-db.org public app repository at http://exist-db.org/exist/apps/public-repo/.
Found an area of the documentation that needs to be improved? Please raise an issue or better yet submit a pull request!
Our test-suite performs a validation check on all articles when you open a pull request. You can speed up the review process by running mvn validate
locally before submitting a pull request.
-
Clone the repository to your system:
$ git clone https://github.com/exist-db/documentation.git exist-documentation
-
Build the documentation application:
$ cd exist-documentation $ mvn clean package
The compiled
.xar
file is located in the/target
directory -
Install this file via the Dashboard > Package Manager.
LGPLv2.1 eXist-db.org