diff options
| author | Indrajith K L | 2025-11-07 04:44:30 +0530 |
|---|---|---|
| committer | Indrajith K L | 2025-11-07 04:44:30 +0530 |
| commit | f3373d08c74e36b2161e1f4e4eef6aa7197352e0 (patch) | |
| tree | 37b07d916f921ddb028fbd729fedddb5d310c7d6 /html_docs/README.md | |
| parent | 8c4b587a2347a911d165f0b4afcce116970ad7e5 (diff) | |
| download | reilua-enhanced-f3373d08c74e36b2161e1f4e4eef6aa7197352e0.tar.gz reilua-enhanced-f3373d08c74e36b2161e1f4e4eef6aa7197352e0.tar.bz2 reilua-enhanced-f3373d08c74e36b2161e1f4e4eef6aa7197352e0.zip | |
docs: Add HTML documentation generator and improve documentation structure
- Add html_docs/ directory with Python-based documentation generator
- Include custom CSS styling for modern, clean documentation layout
- Update README.md with improved formatting and documentation links
- Enhance markdown documentation across all docs/ files:
- Improve API documentation with better code examples
- Refactor DOCUMENTATION_INDEX.md for clearer navigation
- Update EMBEDDING.md, CUSTOMIZATION.md, and other guides
- Standardize formatting and improve readability throughout
- Fix inconsistent line endings and formatting issues
The HTML documentation generator creates a styled, browsable version
of the project documentation for easier reading and navigation.
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. |
