diff options
Diffstat (limited to 'html_docs/README.md')
| -rw-r--r-- | html_docs/README.md | 34 |
1 files changed, 34 insertions, 0 deletions
diff --git a/html_docs/README.md b/html_docs/README.md new file mode 100644 index 0000000..ab45668 --- /dev/null +++ b/html_docs/README.md @@ -0,0 +1,34 @@ +# ReiLua Documentation + +Simple HTML documentation for ReiLua, inspired by the Lua manual style. + +## Contents + +- index.html - Homepage +- manual.html - Complete user guide +- reference.html - API reference (1924 functions and structures) +- style.css - Stylesheet +- generate.py - Documentation generator + +## Viewing + +Open index.html in any web browser. + +## Hosting + +Upload the entire html_docs folder to your web server. + +## Regenerating + +If you update the markdown source files, regenerate with: + + cd html_docs + python generate.py + +Requires Python 3. + +## Style + +Clean white background with navy blue headers, inspired by the official Lua manual. + +Simple, practical, and easy to read. |
