{ "source": "doc/api/documentation.markdown", "miscs": [ { "textRaw": "About this Documentation", "name": "About this Documentation", "type": "misc", "desc": "
The goal of this documentation is to comprehensively explain the Luvit\nAPI, both from a reference as well as a conceptual point of view. Each\nsection describes a built-in module or high-level concept.\n\n
\nWhere appropriate, property types, method arguments, and the arguments\nprovided to event handlers are detailed in a list underneath the topic\nheading.\n\n
\nEvery .html
document has a corresponding .json
document presenting\nthe same information in a structured manner. This feature is\nexperimental, and added for the benefit of IDEs and other utilities that\nwish to do programmatic things with the documentation.\n\n
Every .html
and .json
file is generated based on the corresponding\n.markdown
file in the doc/api/
folder in luvit's source tree. The\ndocumentation is generated using the tools/doc/generate.js
program.\nThe HTML template is located at doc/template.html
.\n\n
There's also a lot of examples in this repo that may be helpful. \n
\n" } ] }