Welcome to Lua Web Docs

Lua Web Docs is an open-source, collaborative project focused on creating clear and comprehensive documentation for Lua. It features detailed reference materials that are easy to understand and include practical examples.

Mission

The mission of Lua Web Docs is to provide a better reference guide for developers. We aim to address the shortcomings of the current official documentation, such as unclear explanations or the lack of examples, by delivering resources that are both practical and user-friendly.

Getting Started

Follow these steps to set up the project locally:

1. Install dependencies:

bash npm install

1. Start the development server:

bash npm run dev

1. Open the website:

Navigate to http://localhost:3000 in your browser to view the site.

Contributing

Contributions are welcome. Whether it's fixing a typo, adding examples, or improving explanations, any input that enhances the documentation is appreciated.

Check the repository's contribution guidelines for details on how to get involved.

Join Discord

Discord Invite Link: https://discord.gg/Jp2HFx3KTH
GitHub Lua Discussion: https://github.com/AurelianSpodarec/LuaDocs/discussions