summaryrefslogtreecommitdiff
path: root/html_docs/README.md
blob: ab45668ea7be3ee606aec12fe6f7013843e339fd (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
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.