L5 website

Documentation site for L5, the Processing-like creative coding library in Lua.

Visit the site at L5lua.org.

TODO

• Finish editing all reference pages and adding screenshots
• Add tutorial and example pages
• Add information on contributions and being listed as a contributor

How to Contribute

This is the website for the L5 documentation site, including the reference. If you'd like to start working on an existing issue, it's suggested you make an issue.

For contributing to L5 itself (not the website), visit the L5 repo.

If you discover a bug or have an idea for a new feature on the website you'd like to add, please begin by submitting an issue so that we can discuss it.

Working on the site locally

The documentation site is built with Material for mkdocs.

1. Fork and Clone your copy of the repository, with GitHub Desktop or in the command line:

git clone https://github.com/YOUR-USERNAME/L5-website.git
cd L5-website

2. Install dependencies

pip install mkdocs-material

If you are working on an OS with an externally-managed python environment, you may have additional steps. For example, in Debian/Ubuntu-based systems:

sudo apt install pipx
pipx ensurepath
# then restart shell or source your config
source ~/.bashrc  # or your shell config
pipx install mkdocs
pipx inject mkdocs mkdocs-material

Or in Void Linux:

sudo xbps-install -S python3-pipx
pipx install mkdocs
pipx inject mkdocs mkdocs-material

3. Make your edits

• Edit markdown files in the docs/ folder
• mkdocs.yml lists all pages in the nav

4. Test locally

mkdocs serve

Visit http://localhost:8000 to preview changes.
5. Commit and push to your fork

git add .
git commit -m "Description of changes"
git push origin main

6. Create a pull request

• On GitHub open a Pull Request from your fork to the main website repo

Notes for Contributors

• Don't commit the site/ folder (it's auto-generated).
• Only edit files in docs/ (and mkdocs.yml if adding a main navigation page)
• The live site is automatically built by GitHub Actions when Pull Requests are merged

Branches

• main is where the site is edited
• gh-pages is built automatically through a workflow action from main. It serves the github pages site.
• gh-pages-lite is a manually-built branch holding the offline version of the website, without images, for downloading through the Offline Documentation section of the Download page. It is built and deployed via the update-lite.sh script.

License

This website uses the MIT license, with the exception of pages listing other licenses. Reference pages contain content adapted from p5.js and Processing by p5.js Contributors and Processing Foundation, licensed under CC BY-NC-SA 4.0.

Tutorial and example pages are MIT licensed unless otherwise noted. Pages adapted from other sources include license and attribution at the bottom.

Love2d installation instructions have been adapted from the Love2d wiki: Getting Started, GNU Free Documentation License 1.3.