Giter VIP home page Giter VIP logo

documentation's Introduction

eXist-db Documentation

Build Status docbook version docbook version

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

Dependencies

Installation

  • 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/.

Contributions

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.

Building from source

  1. Clone the repository to your system:

    $ git clone https://github.com/exist-db/documentation.git exist-documentation
  2. Build the documentation application:

    $ cd exist-documentation
    $ mvn clean package

    The compiled .xar file is located in the /target directory

  3. Install this file via the Dashboard > Package Manager.

License

LGPLv2.1 eXist-db.org

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.