mirror of
https://github.com/ether/etherpad-lite.git
synced 2025-01-19 14:13:34 +01:00
dc0db68515
* Added docs as asciidoctor with cross platform support. * Fixed release script with new doc building mechanism.
13 lines
558 B
Text
13 lines
558 B
Text
== About this Documentation
|
|
|
|
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 `src/bin/doc/generate.js` program.
|
|
The HTML template is located at `doc/template.html`.
|