summaryrefslogtreecommitdiff
path: root/doc/documentation.md
blob: 307c38af808e9db8cf92e7c908b3fc98035c9f07 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
# About this Documentation

<!-- type=misc -->

The goal of this documentation is to comprehensively explain Etherpad,
both from a reference as well as a conceptual point of view.

Where appropriate, property types, method arguments, and the arguments
provided to event handlers are detailed in a list underneath the topic
heading.

Every `.html` file is generated based on the corresponding
`.md` file in the `doc/api/` folder in the source tree. The
documentation is generated using the `bin/doc/generate.js` program.
The HTML template is located at `doc/template.html`.