https://github.com/techplexengineer/luabyexample
A gentle introduction to Lua with examples, inspired by GoByExample.com
https://github.com/techplexengineer/luabyexample
lua
Last synced: about 2 months ago
JSON representation
A gentle introduction to Lua with examples, inspired by GoByExample.com
- Host: GitHub
- URL: https://github.com/techplexengineer/luabyexample
- Owner: TechplexEngineer
- Created: 2021-02-27T23:04:41.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2021-07-14T16:24:02.000Z (over 4 years ago)
- Last Synced: 2025-10-07T22:35:09.392Z (6 months ago)
- Topics: lua
- Language: Go
- Homepage: https://luabyexample.techplexlabs.com
- Size: 6.43 MB
- Stars: 2
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
Awesome Lists containing this project
README
# Lua by Example
Content and build toolchain for [Lua by Example](https://luabyexample.techplexlabs.com/),
a site that teaches Lua via annotated example programs.
### Overview
The Lua by Example site is built by extracting code and
comments from source files in `examples` and rendering
them via the `templates` into a static `public`
directory. The programs implementing this build process
are in `tools`, along with dependencies specified in
the `go.mod`file.
The built `public` directory can be served by any
static content system. The production site uses github pages.
### Building
To build the site you'll need Go and Lua installed. Run:
```console
$ tools/build
```
To build continuously in a loop:
```console
$ tools/build-loop
```
To see the site locally:
```console
$ tools/serve
```
and open `http://127.0.0.1:8000/` in your browser.
### Publishing
The site is published via a Github action
### License
This work is licensed under a
[Creative Commons Attribution 3.0 Unported License](http://creativecommons.org/licenses/by/3.0/).
### Thanks
Thanks to [Mark McGranaghan](https://markmcgranaghan.com/) for
[GoByExample](https://gobyexample.com/) and
[Jeremy Ashkenas](https://github.com/jashkenas)
for [Docco](http://jashkenas.github.com/docco/), both of which
inspired this project.