Skip to main content

lua-docs

aesthetic documentation for the coolest scripting language

What is Lua?

Lua is a powerful, efficient, lightweight, embeddable scripting language. It supports procedural programming, object-oriented programming, functional programming, data-driven programming, and data description.

Lua combines simple procedural syntax with powerful data description constructs based on associative arrays and extensible semantics. Lua is dynamically typed, runs by interpreting bytecode with a register-based virtual machine, and has automatic memory management with incremental garbage collection, making it ideal for configuration, scripting, and rapid prototyping.

(copied from lua.org/about.html)

Why is Lua just better?

Lua is just simple and fast. Only has 22 keywords (in v5.4), only one multi-purpose data structure (the table!), concise syntax (kinda), and an interface with C for embedding, etc. It's so simple; in fact, the documentation (just the manual) for its standard libraries is one long, plain webpage containing everything. Without a dark mode.

Some would call such simplicity beautiful. I decided to take it upon myself to parse over the docs into something slightly better. Over the course of three days, I cracked out the horrors of Docusaurus and React for these lua-docs, returning briefly to the desolate space of web development.

And Some Crediting!

A big thanks to the team at PUC-Rio who created Lua. It's a pretty cool language. The documentation here is meant to be an aesthetic replica of the manual from their website. There may be some innaccuracies in parsing it over.


Lua is free software distributed under the terms of the MIT license reproduced here. Lua may be used for any purpose, including commercial purposes, at absolutely no cost. No paperwork, no royalties, no GNU-like "copyleft" restrictions, either. Just download it and use it.

(copied from lua.org/license.html)