diff --git a/docs/contributing.md b/docs/contributing.md
index e6d72572..66c75bab 100644
--- a/docs/contributing.md
+++ b/docs/contributing.md
@@ -1,18 +1,25 @@
+
+
# Contributing to L5 ❤️
Thanks for your interest in contributing to **L5**! Contributions of all kinds are welcome — from code and documentation to tutorials, examples, and teaching.
-We are inspired by the *[all contributors](https://github.com/all-contributors/all-contributors.github.io)* approach to contribution to open source projects:
+We are inspired by the **[all contributors](https://github.com/all-contributors/all-contributors.github.io)** approach to contribution to open source projects:
-> Our community values contributions of all forms and seeks to expand the meaning of the word contributor as far and wide as possible. It includes documentation, teaching, writing code, making art, writing, design, activism, organizing, curating, or anything else you might imagine. --*from [p5.js Contributor Guidelines](https://p5js.org/contribute/contributor_guidelines/)*
+> Our community values contributions of all forms and seeks to expand the meaning of the word contributor as far and wide as possible. It includes documentation, teaching, writing code, making art, writing, design, activism, organizing, curating, or anything else you might imagine. -- *from [p5.js Contributor Guidelines](https://p5js.org/contribute/contributor_guidelines/)*
If you’re new to open source, don’t worry. This guide explains **which repository to use**, **when to fork**, and **how to get started** step by step.
## Step 1: Decide what you want to contribute
-L5 has **two main repositories**. Which one you use depends on *what you’re working on*.
+L5 has **two main repositories**. Which one you use depends on **what you’re working on**.
-### L5 - The library itself
+### L5 - The library itself
Use this repository if you want to:
@@ -34,7 +41,6 @@ Use this repository if you want to:
**Repository:**
-
## Step 2: Start with an issue
Before writing code or documentation, we recommend **opening an issue** to describe:
@@ -52,7 +58,6 @@ This helps avoid duplicated work and gives you a place to ask questions.
**Website issues:**
-
## Step 3: Fork the repository
If you want to make changes:
@@ -69,7 +74,7 @@ Most contributors work directly on the `main` branch of **their fork**.
### Example (command line)
-After forking the repo on GitHub, clone *your fork*:
+After forking the repo on GitHub, clone **your fork**:
```bash
git clone https://github.com/YOUR-USERNAME/L5-website.git
@@ -97,13 +102,13 @@ Finally, open a Pull Request on GitHub from your fork to the main repository.
- **Create educational content** like zines or video tutorials
- **Develop add-on libraries** or document Lua ecosystem integration
-We follow the *All Contributors* philosophy:
+We follow the **All Contributors** philosophy:
> Our community values contributions of all forms and seeks to expand the meaning of the word contributor.
## Contributors meetings
-We regularly host in-person contributor meetings in NYC. All are welcome! Feel free to [reach out directly](https://leetusman.com/info/) if you'd like to learn more.
+We regularly host in-person contributor meetings in NYC. All are welcome! Feel free to [reach out directly](https://leetusman.com/info/) if you'd like to learn more.
## Winter 2026 L5 Survey
diff --git a/docs/download/index.md b/docs/download/index.md
index 09e1b609..c17eace9 100644
--- a/docs/download/index.md
+++ b/docs/download/index.md
@@ -1,52 +1,20 @@
+# Downloads
+
L5 is free open source software available for Linux, Mac, Windows, Android and iOS.
-L5 programs run using LÖVE (also called Love2d), a free, open-source framework. You'll need to download both L5 and LÖVE to get started.
+L5 programs run using LÖVE (also called Love2d), a free, open-source framework. Love2d is a game framework, just like Godot, Unity, or Unreal. You will use Love2d to run your L5 scripts. This is similar to using a browser to run HTML code.
+
+Covered by this download tutorial:
-## Install overview
+- Download and Install Love2d
+- Download and Open L5 Starter Folder
-**Step-by-step install guides:**
+### Step-by-step install guides
* [macOS](install-mac.md)
* [Windows](install-windows.md)
* [Linux](install-linux.md)
-**Quick start:**
-
-1. Download [Love2d](https://www.love2d.org/)
-2. Download the [L5 Starter project](/L5-starter.zip) and extract it
-3. Open *main.lua* in any text editor and start coding (a starter program is already there)
-4. To run: drag the L5-starter folder onto the Love application, or run from command line/IDE. See [Getting Started](/getting-started) for details.
-
-## Downloads
-
-### L5 Starter Project (Recommended)
-
-This compressed folder contains the *L5.lua* library, a starter *main.lua* file (with `require('L5')` already included), and a *README*.
-
-[Download L5 Starter project](/L5-starter.zip)
-
-### Individual Downloads
-
-**Latest version:** [Download L5.lua](https://raw.githubusercontent.com/L5lua/L5/main/L5.lua)
-
-**Stable release (v0.1.6):** [Download L5.lua v0.1.6](https://raw.githubusercontent.com/L5lua/L5/v0.1.6/L5.lua)
-
-### Source code
-
-The [L5 repository](https://github.com/L5lua/L5) is accessible for anyone interested in viewing or modifying the L5 source code. See [contributing](/contributing.md) for ways to contribute to the library or this site.
-
-## Offline Documentation
-
-This L5 documentation site is available for download to run offline, with or without images.
-
-* [Download L5lua.org with images (8MB ZIP)](https://github.com/L5lua/L5-website/archive/refs/heads/gh-pages.zip)
-* [Download L5lua.org without images (2MB ZIP)](https://github.com/L5lua/L5-website/archive/refs/heads/gh-pages-lite.zip)
-
-After downloading, extract the ZIP and serve the folder with a local web server.
-
-* For a quick local server, navigate to the extracted folder in your command line and run `python -m http.server` (Python 3) or `python -m SimpleHTTPServer` (Python 2).
-
-## Running your programs
-
-To get started running L5 check out [Getting Started](/getting-started) or the [tutorials](/tutorials/) to learn more.
+Congratulations! You've now installed Love and have L5 on your computer and verified you can run your own programs.
+Now your computer you are ready to write and [run your L5 programs](running.md).
diff --git a/docs/download/install-linux.md b/docs/download/install-linux.md
index b350b4d7..20f9706c 100644
--- a/docs/download/install-linux.md
+++ b/docs/download/install-linux.md
@@ -70,5 +70,4 @@ love .
It should now launch and you should see a new window open with your code sketch running.
-**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out [Getting Started](/getting-started) or the [tutorials](/tutorials/) to learn more.
-
+**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out other ways to [run your own programs](running.md).
diff --git a/docs/download/install-mac.md b/docs/download/install-mac.md
index ad93bb60..620e6e4b 100644
--- a/docs/download/install-mac.md
+++ b/docs/download/install-mac.md
@@ -11,7 +11,7 @@ This tutorial walks you through installing L5 with the Love (Love2d) framework o
1. Love is the underlying Framework that will allow L5 code to run on your computer. So we start by installing Love. Go to the [Love website](https://love2d.org) and click to download the 64-bit zipped Mac program.
2. Click **"Allow"** if it asks 'Do you want to allow downloads on "love2d.org"?' It should download to your *Downloads* folder by default.
-
+
3. Now on your desktop (called "Finder" on macOS) open up your *Downloads* folder. You can right click and choose Open (see screenshot) or double click on Love to launch it.
4. A warning popup box opens to say the program and code is not verified by Apple since you will be writing your own custom code. If you can choose Open because you turned off restrictions, then choose Open! Otherwise, **DO NOT** move to the trash.
@@ -23,8 +23,8 @@ This tutorial walks you through installing L5 with the Love (Love2d) framework o
7. From the L5lua.org Download page, [download the L5 Starter project](/L5-starter.zip).
8. Click **"Allow"** if it asks 'Do you want to allow downloads on "l5lua.org"?'
-
+
9. Back in your downloads folder, **drag the L5-starter folder onto the Love application in the folder**. It should now launch and you should see a new window open with your code sketch.
-**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out [Getting Started](/getting-started) or the [tutorials](index.md) to learn more about where you can edit your code and run it.
+**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out other ways to [run your own programs](running.md).
diff --git a/docs/download/install-windows.md b/docs/download/install-windows.md
index 9d3b3281..3e1f9daf 100644
--- a/docs/download/install-windows.md
+++ b/docs/download/install-windows.md
@@ -11,4 +11,4 @@ This tutorial walks you through installing L5 with the Love (Love2d) framework o
7. You should see a window open with a flying bird-shaped balloon and clouds, verifying that Love is now properly installed on your computer. **At this point you can close the window.**
8. Back in your downloads folder, **extract the L5-starter.zip file** the same way you extracted the Love zip file. Then **drag the L5-starter folder onto the love.exe application**. It should now launch and you should see a new window open with your code sketch.
-**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out [Getting Started](/getting-started) or the [tutorials](/tutorials/) to learn more.
+**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out other ways to [run your own programs](running.md).
diff --git a/docs/getting-started.md b/docs/download/running.md
similarity index 77%
rename from docs/getting-started.md
rename to docs/download/running.md
index c52abcc8..a5c4ec53 100644
--- a/docs/getting-started.md
+++ b/docs/download/running.md
@@ -1,10 +1,12 @@
-You can run L5 programs from your downloaded folder or via the command line or an Integrated Development Environment (IDE).
+# Running Your Programs
-IDEs such as ZeroBrane Studio, Sublime Text, VS Code, Notepad++, and SciTE all support launching LÖVE programs (the underlying framework used by L5), though require additional setup configuration not covered here.
+There are two ways to run a L5 program -- one method is using the desktop and the other uses the command line interface (CLI). If you are new to computing or are unsure about the CLI, then run from the desktop!
+
+IDEs such as ZeroBrane Studio, Sublime Text, VS Code, Notepad++, and SciTE all support launching LÖVE programs (the engine to run our L5 scripts), though require additional setup configuration not covered here.
## Running L5 from the desktop
-The easiest way to run your L5 program is to drag the **folder** containing your main.lua onto the Love2d application. Remember to drag the **folder** containing `main.lua`, and not `main.lua` itself.
+The easiest way to run your L5 program is to drag the **folder** containing your main.lua onto the Love2d application. Remember to drag the **folder** containing `main.lua`, and not `main.lua` itself.
It should launch and open a new window with your sketch running in it, or print an error message. If you're running the L5 Starter program, you should see a square window with a yellow background. Congratulations.
@@ -14,22 +16,16 @@ It should launch and open a new window with your sketch running in it, or print
## Running L5 from the command line
-Running L5 from the command line allows you to see the output of `describe()`, `print()` and any error messages in the console.
-
-### Linux command line
-
-In the Terminal, you can run `love path/to/L5-starter`. Or if you are in the folder with your program, run `love .` to launch your project from the current directory.
-
-### Windows command line
-
+### Windows Command line
You can launch your programs from the command line and add the `--console` flag to be able to see print() and error() output as well:
+
```
-"C:\Program Files\LOVE\love.exe" --console "C:\Users\\Desktop\L5-starter"
+"C:\Program Files\LOVE\love.exe" --console
+"C:\Users\\Desktop\L5-starter"
```
-
Replace `` and `Desktop\L5-starter` with your actual username and the location of your program folder.
-### macOS command line
+### macOS Command Line
There are a few extra steps to smoothly set up command line usage for L5 in the command line on Mac.
@@ -79,6 +75,10 @@ source ~/.zshrc
love ~/path/to/my-program
```
----
+### Linux Command line
+
+In the Terminal, you can run `love path/to/L5-starter`. Or if you are in the folder with your program, run `love .` to launch your project from the current directory.
*Instructions adapted from [Love2d wiki: Getting Started](https://www.love2d.org/wiki/Getting_Started), GNU Free Documentation License 1.3.*
+
+Amazing! Now you are ready to start learning with [First Steps](../tutorials/first-steps.md). If you are familiar with Lua, p5.js, or Processing already, you should take a look at [L5 for Processing-p5.js Programmers](../L5-for-processingp5.md).
diff --git a/docs/index.md b/docs/index.md
index 0f79cae6..4ddbcd23 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -1,11 +1,20 @@
# Welcome to L5
-
+
-L5 is a fun, fast, cross-platform, and lightweight implementation of the Processing API in Lua. It is a free and open source coding library to make interactive artwork on the computer, aimed at artists, designers, and anyone that wants a flexible way to prototype art, games, toys, and other software experiments in code.
+L5 is a fun, fast, cross-platform, and lightweight implementation of the **[Processing API](https://processing.org/)** in **[Lua](https://www.lua.org/)**. It is a free and open source coding library to make interactive artwork on the computer, aimed at artists, designers, and anyone that wants a flexible way to prototype art, games, toys, and other software experiments in code.
-L5 is designed to work cross-platform, including on desktop, phone, and tablet. Beyond running fast on modern machines, L5 is optimized for older and lower-powered devices, minimizing resource usage to keep creative coding accessible to everyone. This helps with our goal of building resilient, long-lasting software projects. L5 is built in Lua, a robust but lightweight, long-running, lightning-fast, extensible language.
+> Processing is not a single programming language, but an arts-centric system for learning, teaching, and making visual form with code. **-[Processing.py reference](https://py.processing.org/reference/)**
+L5 brings the familiar Processing creative coding environment to Lua, offering some of the best aspects of both Processing and p5.js with some twists of its own. But you don't need to know Processing already to get started with L5. L5 is built on top of the Love2d framework, and offers near-instant loading times and excellent performance. **L5 is not an official implementation of Processing or the Processing Foundation. It is a community-created project.**
+
+Beyond running fast on modern machines, L5 is optimized for older and lower-powered devices, minimizing resource usage to keep creative coding accessible to everyone. This helps with our goal of building resilient, long-lasting software projects. L5 is built in Lua, a robust but lightweight, long-running, lightning-fast, extensible language, that works on desktop, phone, and tablet.
+
+*L5 aims to make creative coding accessible, fast, and fun while leveraging the power and simplicity of Lua and a commitment to making resilient, long-lasting tools.*
+
+## How L5 Works
+
+L5 is a Lua library. Your L5 code runs inside **[Love2d](https://www.love2d.org/)**, a free open-source game framework. Think of Love2d as the engine and L5 as the creative coding toolkit on top. You download both: Love2d to run programs, and L5 to write them using a Processing-style API.
## Example sketch
@@ -32,16 +41,6 @@ function mousePressed()
end
```
-## How L5 Works
-
-L5 is a Lua library. Your L5 code runs inside **[Love2D](https://www.love2d.org/)**, a free open-source game framework. Think of Love2D as the engine and L5 as the creative coding toolkit on top. You download both: Love2D to run programs, and L5 to write them using a Processing-style API.
-
-## Overview
-
-L5 brings the familiar Processing creative coding environment to Lua, offering some of the best aspects of both Processing and p5.js with some twists of its own. But you don't need to know Processing already to get started with L5. L5 is built on top of the Love2D framework, and offers near-instant loading times and excellent performance while maintaining the intuitive API that makes [Processing](https://processing.org/) accessible to artists and designers. *L5 is not an official implementation of Processing or the Processing Foundation. It is a community-created project.*
-
-> Processing is not a single programming language, but an arts-centric system for learning, teaching, and making visual form with code. *-[Processing.py reference](https://py.processing.org/reference/)*
-
## Why Lua?
Lua is a versatile programming language known for its simplicity and efficiency. It has a straightforward easy-to-learn syntax, accessible for beginners, and it's efficient for experienced programmers as well.
@@ -54,7 +53,7 @@ Where Java undergoes regular major updates and JavaScript is a fast-evolving and
- **Lightning fast**: Scripts, images, and audio load near-instantly
- **Easy syntax**: Easy to learn and consistent syntax.
-- **Minimal footprint**: L5 (~6MB, from Love2D ~4.5MB + LuaJIT ~1.5MB) vs Processing (~500MB) vs p5.js (~1-4MB + browser ~250-355MB)
+- **Minimal footprint**: L5 (~6MB, from Love2d ~4.5MB + LuaJIT ~1.5MB) vs Processing (~500MB) vs p5.js (~1-4MB + browser ~250-355MB)
- **Lighter impact**: Runs on older hardware and devices.
- **Cross-platform**: Runs on Windows, macOS, Linux, iOS, Android, Raspberry Pi
- **Synchronous execution**: Code runs in predictable order, no async complexity
@@ -68,21 +67,19 @@ Where Java undergoes regular major updates and JavaScript is a fast-evolving and
- **Tables everywhere**: Lua uses tables for arrays, objects, and data structures
- **OOP patterns**: Check Lua documentation for object-oriented programming approaches
-## Getting Started
+## Get Involved
-Ready to try L5? Check out the [download](download/index.md) page for an installation guide and the [tutorials](tutorials/index.md) for easy ways to get started.
-
-## Community and Support
+***Ready to try L5?***
+Continue to the **[download](download/index.md)** page for an installation guide and the **[tutorials](tutorials/index.md)** for easy ways to get started.
+***Want to contribute?***
While L5 is a new project with growing documentation, it benefits from:
- The welcoming Processing community and their decade+ of resources
- Extensive Processing tutorials, books, and forums that translate well to L5
-- The stable Lua and Love2D ecosystems
+- The stable Lua and Love2d ecosystems
- Active development and community contributions
Note: As L5 is new, documentation and examples are still growing compared to the mature Processing ecosystem.
---
-
-*L5 aims to make creative coding accessible, fast, and fun while leveraging the power and simplicity of Lua and a commitment to making resilient, long-lasting tools.*
diff --git a/docs/reference/index.md b/docs/reference/index.md
index 213a005b..9481fbae 100644
--- a/docs/reference/index.md
+++ b/docs/reference/index.md
@@ -1,3 +1,5 @@
+# Reference
+
An offline version of this documentation is available for [download](/download/#offline-documentation).
## Shape
diff --git a/docs/tutorials/first-steps.md b/docs/tutorials/first-steps.md
index 746dc836..e28ce636 100644
--- a/docs/tutorials/first-steps.md
+++ b/docs/tutorials/first-steps.md
@@ -121,5 +121,5 @@ The Reference was written with the beginner in mind, but may still take some eff
### Where to go next
-From here, check out [A complete introduction to programming with L5](/tutorials/#a-complete-introduction-to-programming-with-l5).
+From here, check out [A complete introduction to programming with L5](/tutorials/).
diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md
index 1afb8833..8ff817fb 100644
--- a/docs/tutorials/index.md
+++ b/docs/tutorials/index.md
@@ -1,25 +1,24 @@
+# Tutorials
-[First Steps](first-steps.md) - Welcome to L5! This introduction covers the basics of setting up L5 on your computer.
+**A complete introduction to programming with L5**
-## A complete introduction to programming with L5
+1. [First Steps](first-steps.md) - Welcome to L5! This introduction covers the basics of setting up L5 on your computer.
+2. [Welcome to Coding](welcome-to-coding.md)
+3. [Calling Functions](calling-functions.md)
+4. [Using Variables](using-variables.md)
+5. [Creating Variables](creating-variables.md)
+6. [Creating Functions](creating-functions.md)
+7. [If Statements](if-statements.md)
+8. [Animation](animation.md)
+9. [Input](input.md)
+10. [For Loops](for-loops.md)
+11. [Arrays (Ordered Tables)](arrays-tables.md)
+12. [Using Objects](using-objects.md)
-* [Welcome to Coding](welcome-to-coding.md)
-* [Calling Functions](calling-functions.md)
-* [Using Variables](using-variables.md)
-* [Creating Variables](creating-variables.md)
-* [Creating Functions](creating-functions.md)
-* [If Statements](if-statements.md)
-* [Animation](animation.md)
-* [Input](input.md)
-* [For Loops](for-loops.md)
-* [Arrays (Ordered Tables)](arrays-tables.md)
-* [Using Objects](using-objects.md)
+**Other Resources**
-## More tutorials
-
-* [Computational Poetry with L5](computational-poetry.md) - A workshop tutorial created for [CCFest 2026](https://ccfest.rocks)
-* [Data Structure Garden](data-structure-garden.md) - Another tutorial on how to use objects and arrays
-* [Video](video.md) - An intro to video formats, and loading and playing videos with L5
+- [Computational Poetry with L5](computational-poetry.md) - A workshop tutorial created for [CCFest 2026](https://ccfest.rocks)
+- [Data Structure Garden](data-structure-garden.md) - Another tutorial on how to use objects and arrays
+- [Video](video.md) - An intro to video formats, and loading and playing videos with L5
*Have an idea for a tutorial you'd like to see? Or have one to contribute? L5 is new and could use some help building out its tutorials. Check out [Contributing](/contributing) for more information on writing and submitting your own.*
-
diff --git a/mkdocs.yml b/mkdocs.yml
index 65b17bc9..3971cf8c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: "L5: A Processing Library in Lua"
+site_name: 'L5: A Processing Library in Lua'
site_url: https://l5lua.org
validation:
absolute_links: ignore
@@ -15,7 +15,11 @@ theme:
font: false
favicon: assets/L5-logo-blob.png
features:
- - navigation.indexes
+ - navigation.tracking # URL address bar
+ - navigation.prune # Render only visible navigation
+ - navigation.path # Breadcrumbs for beginning of filename
+ - toc.follow # Follow navigation
+ - toc.integrate # rendering nav bar to the left
- content.code.copy # Copy button
- content.code.select # Allow selecting code
custom_dir: overrides
@@ -25,37 +29,27 @@ extra_css:
- stylesheets/extra.css
extra:
generator: false
+# Added for collapsible tabs for installations
+markdown_extensions:
+ - toc:
+ toc_depth: 2
nav:
- - Welcome to L5: index.md
- - Download:
- - Download: download/index.md
- - Install for Mac: download/install-mac.md
- - Install for Windows: download/install-windows.md
- - Install for Linux: download/install-linux.md
- - Getting Started: getting-started.md
- - L5 for Processing-p5.js programmers: L5-for-processingp5.md
- - Reference:
- - Reference Summary: reference/index.md
- - Shape: reference/#shape
- - Color: reference/#color
- - Typography: reference/#typography
- - Image: reference/#image
- - Media: reference/#media
- - Transform: reference/#transform
- - Environment: reference/#environment
- - Rendering: reference/#rendering
- - Math: reference/#math
- - IO: reference/#io
- - Events: reference/#events
- - Data: reference/#data
- - Structure: reference/#structure
- - Constants: reference/#constants
- - Foundation: reference/#foundation
- - Tutorials: tutorials/index.md
- - Examples: examples/index.md
- - Forum: https://discourse.processing.org/c/l5/
- - Bug Reports: bug-reports.md
- - Contributing: contributing.md
- - For developers: how.md
- - Copyleft: copyleft.md
- - Blog: https://notapipe.itch.io/l5/devlog
+ - Home: index.md
+ - Getting Started:
+ - download/index.md
+ - Mac: download/install-mac.md
+ - Windows: download/install-windows.md
+ - Linux: download/install-linux.md
+ - Running Your Programs: download/running.md
+ - Learn:
+ - Tutorials: tutorials/index.md
+ - Examples: examples/index.md
+ - L5 for Processing-p5.js programmers: L5-for-processingp5.md
+ - Reference: reference/index.md
+ - Contributing:
+ - How To: contributing.md
+ - Developer Resources: how.md
+ - Bug Reports: bug-reports.md
+ - Copyleft: copyleft.md
+ - ➘ Forum: https://discourse.processing.org/c/l5/
+ - ➘ Blog: https://notapipe.itch.io/l5/devlog
diff --git a/overrides/partials/content.html b/overrides/partials/content.html
new file mode 100644
index 00000000..a68a2665
--- /dev/null
+++ b/overrides/partials/content.html
@@ -0,0 +1,11 @@
+{#-
+ This file was automatically generated - do not edit
+-#}
+{% include "partials/tags.html" %}
+{% include "partials/actions.html" %}
+{% if "\u003ch1" not in page.content %}
+{% endif %}
+{{ page.content }}
+{% include "partials/source-file.html" %}
+{% include "partials/feedback.html" %}
+{% include "partials/comments.html" %}
diff --git a/overrides/partials/nav.html b/overrides/partials/nav.html
new file mode 100644
index 00000000..f9791f45
--- /dev/null
+++ b/overrides/partials/nav.html
@@ -0,0 +1,11 @@
+{#- This file was automatically generated - do not edit -#} {% import
+"partials/nav-item.html" as item with context %} {% set class = "md-nav
+md-nav--primary" %} {% if "navigation.tabs" in features %} {% set class = class
+~ " md-nav--lifted" %} {% endif %} {% if "toc.integrate" in features %} {% set
+class = class ~ " md-nav--integrated" %} {% endif %}
+
-**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out [Getting Started](/getting-started) or the [tutorials](/tutorials/) to learn more.
-
+**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out other ways to [run your own programs](running.md).
diff --git a/docs/download/install-mac.md b/docs/download/install-mac.md
index ad93bb60..620e6e4b 100644
--- a/docs/download/install-mac.md
+++ b/docs/download/install-mac.md
@@ -11,7 +11,7 @@ This tutorial walks you through installing L5 with the Love (Love2d) framework o
1. Love is the underlying Framework that will allow L5 code to run on your computer. So we start by installing Love. Go to the [Love website](https://love2d.org) and click to download the 64-bit zipped Mac program.
2. Click **"Allow"** if it asks 'Do you want to allow downloads on "love2d.org"?' It should download to your *Downloads* folder by default.
-
+
3. Now on your desktop (called "Finder" on macOS) open up your *Downloads* folder. You can right click and choose Open (see screenshot) or double click on Love to launch it.
4. A warning popup box opens to say the program and code is not verified by Apple since you will be writing your own custom code. If you can choose Open because you turned off restrictions, then choose Open! Otherwise, **DO NOT** move to the trash.
@@ -23,8 +23,8 @@ This tutorial walks you through installing L5 with the Love (Love2d) framework o
7. From the L5lua.org Download page, [download the L5 Starter project](/L5-starter.zip).
8. Click **"Allow"** if it asks 'Do you want to allow downloads on "l5lua.org"?'
-
+
9. Back in your downloads folder, **drag the L5-starter folder onto the Love application in the folder**. It should now launch and you should see a new window open with your code sketch.
-**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out [Getting Started](/getting-started) or the [tutorials](index.md) to learn more about where you can edit your code and run it.
+**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out other ways to [run your own programs](running.md).
diff --git a/docs/download/install-windows.md b/docs/download/install-windows.md
index 9d3b3281..3e1f9daf 100644
--- a/docs/download/install-windows.md
+++ b/docs/download/install-windows.md
@@ -11,4 +11,4 @@ This tutorial walks you through installing L5 with the Love (Love2d) framework o
7. You should see a window open with a flying bird-shaped balloon and clouds, verifying that Love is now properly installed on your computer. **At this point you can close the window.**
8. Back in your downloads folder, **extract the L5-starter.zip file** the same way you extracted the Love zip file. Then **drag the L5-starter folder onto the love.exe application**. It should now launch and you should see a new window open with your code sketch.
-**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out [Getting Started](/getting-started) or the [tutorials](/tutorials/) to learn more.
+**Next steps:** You've installed Love and have L5 on your computer and verified you can run your own programs. Check out other ways to [run your own programs](running.md).
diff --git a/docs/getting-started.md b/docs/download/running.md
similarity index 77%
rename from docs/getting-started.md
rename to docs/download/running.md
index c52abcc8..a5c4ec53 100644
--- a/docs/getting-started.md
+++ b/docs/download/running.md
@@ -1,10 +1,12 @@
-You can run L5 programs from your downloaded folder or via the command line or an Integrated Development Environment (IDE).
+# Running Your Programs
-IDEs such as ZeroBrane Studio, Sublime Text, VS Code, Notepad++, and SciTE all support launching LÖVE programs (the underlying framework used by L5), though require additional setup configuration not covered here.
+There are two ways to run a L5 program -- one method is using the desktop and the other uses the command line interface (CLI). If you are new to computing or are unsure about the CLI, then run from the desktop!
+
+IDEs such as ZeroBrane Studio, Sublime Text, VS Code, Notepad++, and SciTE all support launching LÖVE programs (the engine to run our L5 scripts), though require additional setup configuration not covered here.
## Running L5 from the desktop
-The easiest way to run your L5 program is to drag the **folder** containing your main.lua onto the Love2d application. Remember to drag the **folder** containing `main.lua`, and not `main.lua` itself.
+The easiest way to run your L5 program is to drag the **folder** containing your main.lua onto the Love2d application. Remember to drag the **folder** containing `main.lua`, and not `main.lua` itself.
It should launch and open a new window with your sketch running in it, or print an error message. If you're running the L5 Starter program, you should see a square window with a yellow background. Congratulations.
@@ -14,22 +16,16 @@ It should launch and open a new window with your sketch running in it, or print
## Running L5 from the command line
-Running L5 from the command line allows you to see the output of `describe()`, `print()` and any error messages in the console.
-
-### Linux command line
-
-In the Terminal, you can run `love path/to/L5-starter`. Or if you are in the folder with your program, run `love .` to launch your project from the current directory.
-
-### Windows command line
-
+### Windows Command line
You can launch your programs from the command line and add the `--console` flag to be able to see print() and error() output as well:
+
```
-"C:\Program Files\LOVE\love.exe" --console "C:\Users\
-L5 is a fun, fast, cross-platform, and lightweight implementation of the Processing API in Lua. It is a free and open source coding library to make interactive artwork on the computer, aimed at artists, designers, and anyone that wants a flexible way to prototype art, games, toys, and other software experiments in code.
+L5 is a fun, fast, cross-platform, and lightweight implementation of the **[Processing API](https://processing.org/)** in **[Lua](https://www.lua.org/)**. It is a free and open source coding library to make interactive artwork on the computer, aimed at artists, designers, and anyone that wants a flexible way to prototype art, games, toys, and other software experiments in code.
-L5 is designed to work cross-platform, including on desktop, phone, and tablet. Beyond running fast on modern machines, L5 is optimized for older and lower-powered devices, minimizing resource usage to keep creative coding accessible to everyone. This helps with our goal of building resilient, long-lasting software projects. L5 is built in Lua, a robust but lightweight, long-running, lightning-fast, extensible language.
+> Processing is not a single programming language, but an arts-centric system for learning, teaching, and making visual form with code. **-[Processing.py reference](https://py.processing.org/reference/)**
+L5 brings the familiar Processing creative coding environment to Lua, offering some of the best aspects of both Processing and p5.js with some twists of its own. But you don't need to know Processing already to get started with L5. L5 is built on top of the Love2d framework, and offers near-instant loading times and excellent performance. **L5 is not an official implementation of Processing or the Processing Foundation. It is a community-created project.**
+
+Beyond running fast on modern machines, L5 is optimized for older and lower-powered devices, minimizing resource usage to keep creative coding accessible to everyone. This helps with our goal of building resilient, long-lasting software projects. L5 is built in Lua, a robust but lightweight, long-running, lightning-fast, extensible language, that works on desktop, phone, and tablet.
+
+*L5 aims to make creative coding accessible, fast, and fun while leveraging the power and simplicity of Lua and a commitment to making resilient, long-lasting tools.*
+
+## How L5 Works
+
+L5 is a Lua library. Your L5 code runs inside **[Love2d](https://www.love2d.org/)**, a free open-source game framework. Think of Love2d as the engine and L5 as the creative coding toolkit on top. You download both: Love2d to run programs, and L5 to write them using a Processing-style API.
## Example sketch
@@ -32,16 +41,6 @@ function mousePressed()
end
```
-## How L5 Works
-
-L5 is a Lua library. Your L5 code runs inside **[Love2D](https://www.love2d.org/)**, a free open-source game framework. Think of Love2D as the engine and L5 as the creative coding toolkit on top. You download both: Love2D to run programs, and L5 to write them using a Processing-style API.
-
-## Overview
-
-L5 brings the familiar Processing creative coding environment to Lua, offering some of the best aspects of both Processing and p5.js with some twists of its own. But you don't need to know Processing already to get started with L5. L5 is built on top of the Love2D framework, and offers near-instant loading times and excellent performance while maintaining the intuitive API that makes [Processing](https://processing.org/) accessible to artists and designers. *L5 is not an official implementation of Processing or the Processing Foundation. It is a community-created project.*
-
-> Processing is not a single programming language, but an arts-centric system for learning, teaching, and making visual form with code. *-[Processing.py reference](https://py.processing.org/reference/)*
-
## Why Lua?
Lua is a versatile programming language known for its simplicity and efficiency. It has a straightforward easy-to-learn syntax, accessible for beginners, and it's efficient for experienced programmers as well.
@@ -54,7 +53,7 @@ Where Java undergoes regular major updates and JavaScript is a fast-evolving and
- **Lightning fast**: Scripts, images, and audio load near-instantly
- **Easy syntax**: Easy to learn and consistent syntax.
-- **Minimal footprint**: L5 (~6MB, from Love2D ~4.5MB + LuaJIT ~1.5MB) vs Processing (~500MB) vs p5.js (~1-4MB + browser ~250-355MB)
+- **Minimal footprint**: L5 (~6MB, from Love2d ~4.5MB + LuaJIT ~1.5MB) vs Processing (~500MB) vs p5.js (~1-4MB + browser ~250-355MB)
- **Lighter impact**: Runs on older hardware and devices.
- **Cross-platform**: Runs on Windows, macOS, Linux, iOS, Android, Raspberry Pi
- **Synchronous execution**: Code runs in predictable order, no async complexity
@@ -68,21 +67,19 @@ Where Java undergoes regular major updates and JavaScript is a fast-evolving and
- **Tables everywhere**: Lua uses tables for arrays, objects, and data structures
- **OOP patterns**: Check Lua documentation for object-oriented programming approaches
-## Getting Started
+## Get Involved
-Ready to try L5? Check out the [download](download/index.md) page for an installation guide and the [tutorials](tutorials/index.md) for easy ways to get started.
-
-## Community and Support
+***Ready to try L5?***
+Continue to the **[download](download/index.md)** page for an installation guide and the **[tutorials](tutorials/index.md)** for easy ways to get started.
+***Want to contribute?***
While L5 is a new project with growing documentation, it benefits from:
- The welcoming Processing community and their decade+ of resources
- Extensive Processing tutorials, books, and forums that translate well to L5
-- The stable Lua and Love2D ecosystems
+- The stable Lua and Love2d ecosystems
- Active development and community contributions
Note: As L5 is new, documentation and examples are still growing compared to the mature Processing ecosystem.
---
-
-*L5 aims to make creative coding accessible, fast, and fun while leveraging the power and simplicity of Lua and a commitment to making resilient, long-lasting tools.*
diff --git a/docs/reference/index.md b/docs/reference/index.md
index 213a005b..9481fbae 100644
--- a/docs/reference/index.md
+++ b/docs/reference/index.md
@@ -1,3 +1,5 @@
+# Reference
+
An offline version of this documentation is available for [download](/download/#offline-documentation).
## Shape
diff --git a/docs/tutorials/first-steps.md b/docs/tutorials/first-steps.md
index 746dc836..e28ce636 100644
--- a/docs/tutorials/first-steps.md
+++ b/docs/tutorials/first-steps.md
@@ -121,5 +121,5 @@ The Reference was written with the beginner in mind, but may still take some eff
### Where to go next
-From here, check out [A complete introduction to programming with L5](/tutorials/#a-complete-introduction-to-programming-with-l5).
+From here, check out [A complete introduction to programming with L5](/tutorials/).
diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md
index 1afb8833..8ff817fb 100644
--- a/docs/tutorials/index.md
+++ b/docs/tutorials/index.md
@@ -1,25 +1,24 @@
+# Tutorials
-[First Steps](first-steps.md) - Welcome to L5! This introduction covers the basics of setting up L5 on your computer.
+**A complete introduction to programming with L5**
-## A complete introduction to programming with L5
+1. [First Steps](first-steps.md) - Welcome to L5! This introduction covers the basics of setting up L5 on your computer.
+2. [Welcome to Coding](welcome-to-coding.md)
+3. [Calling Functions](calling-functions.md)
+4. [Using Variables](using-variables.md)
+5. [Creating Variables](creating-variables.md)
+6. [Creating Functions](creating-functions.md)
+7. [If Statements](if-statements.md)
+8. [Animation](animation.md)
+9. [Input](input.md)
+10. [For Loops](for-loops.md)
+11. [Arrays (Ordered Tables)](arrays-tables.md)
+12. [Using Objects](using-objects.md)
-* [Welcome to Coding](welcome-to-coding.md)
-* [Calling Functions](calling-functions.md)
-* [Using Variables](using-variables.md)
-* [Creating Variables](creating-variables.md)
-* [Creating Functions](creating-functions.md)
-* [If Statements](if-statements.md)
-* [Animation](animation.md)
-* [Input](input.md)
-* [For Loops](for-loops.md)
-* [Arrays (Ordered Tables)](arrays-tables.md)
-* [Using Objects](using-objects.md)
+**Other Resources**
-## More tutorials
-
-* [Computational Poetry with L5](computational-poetry.md) - A workshop tutorial created for [CCFest 2026](https://ccfest.rocks)
-* [Data Structure Garden](data-structure-garden.md) - Another tutorial on how to use objects and arrays
-* [Video](video.md) - An intro to video formats, and loading and playing videos with L5
+- [Computational Poetry with L5](computational-poetry.md) - A workshop tutorial created for [CCFest 2026](https://ccfest.rocks)
+- [Data Structure Garden](data-structure-garden.md) - Another tutorial on how to use objects and arrays
+- [Video](video.md) - An intro to video formats, and loading and playing videos with L5
*Have an idea for a tutorial you'd like to see? Or have one to contribute? L5 is new and could use some help building out its tutorials. Check out [Contributing](/contributing) for more information on writing and submitting your own.*
-
diff --git a/mkdocs.yml b/mkdocs.yml
index 65b17bc9..3971cf8c 100644
--- a/mkdocs.yml
+++ b/mkdocs.yml
@@ -1,4 +1,4 @@
-site_name: "L5: A Processing Library in Lua"
+site_name: 'L5: A Processing Library in Lua'
site_url: https://l5lua.org
validation:
absolute_links: ignore
@@ -15,7 +15,11 @@ theme:
font: false
favicon: assets/L5-logo-blob.png
features:
- - navigation.indexes
+ - navigation.tracking # URL address bar
+ - navigation.prune # Render only visible navigation
+ - navigation.path # Breadcrumbs for beginning of filename
+ - toc.follow # Follow navigation
+ - toc.integrate # rendering nav bar to the left
- content.code.copy # Copy button
- content.code.select # Allow selecting code
custom_dir: overrides
@@ -25,37 +29,27 @@ extra_css:
- stylesheets/extra.css
extra:
generator: false
+# Added for collapsible tabs for installations
+markdown_extensions:
+ - toc:
+ toc_depth: 2
nav:
- - Welcome to L5: index.md
- - Download:
- - Download: download/index.md
- - Install for Mac: download/install-mac.md
- - Install for Windows: download/install-windows.md
- - Install for Linux: download/install-linux.md
- - Getting Started: getting-started.md
- - L5 for Processing-p5.js programmers: L5-for-processingp5.md
- - Reference:
- - Reference Summary: reference/index.md
- - Shape: reference/#shape
- - Color: reference/#color
- - Typography: reference/#typography
- - Image: reference/#image
- - Media: reference/#media
- - Transform: reference/#transform
- - Environment: reference/#environment
- - Rendering: reference/#rendering
- - Math: reference/#math
- - IO: reference/#io
- - Events: reference/#events
- - Data: reference/#data
- - Structure: reference/#structure
- - Constants: reference/#constants
- - Foundation: reference/#foundation
- - Tutorials: tutorials/index.md
- - Examples: examples/index.md
- - Forum: https://discourse.processing.org/c/l5/
- - Bug Reports: bug-reports.md
- - Contributing: contributing.md
- - For developers: how.md
- - Copyleft: copyleft.md
- - Blog: https://notapipe.itch.io/l5/devlog
+ - Home: index.md
+ - Getting Started:
+ - download/index.md
+ - Mac: download/install-mac.md
+ - Windows: download/install-windows.md
+ - Linux: download/install-linux.md
+ - Running Your Programs: download/running.md
+ - Learn:
+ - Tutorials: tutorials/index.md
+ - Examples: examples/index.md
+ - L5 for Processing-p5.js programmers: L5-for-processingp5.md
+ - Reference: reference/index.md
+ - Contributing:
+ - How To: contributing.md
+ - Developer Resources: how.md
+ - Bug Reports: bug-reports.md
+ - Copyleft: copyleft.md
+ - ➘ Forum: https://discourse.processing.org/c/l5/
+ - ➘ Blog: https://notapipe.itch.io/l5/devlog
diff --git a/overrides/partials/content.html b/overrides/partials/content.html
new file mode 100644
index 00000000..a68a2665
--- /dev/null
+++ b/overrides/partials/content.html
@@ -0,0 +1,11 @@
+{#-
+ This file was automatically generated - do not edit
+-#}
+{% include "partials/tags.html" %}
+{% include "partials/actions.html" %}
+{% if "\u003ch1" not in page.content %}
+{% endif %}
+{{ page.content }}
+{% include "partials/source-file.html" %}
+{% include "partials/feedback.html" %}
+{% include "partials/comments.html" %}
diff --git a/overrides/partials/nav.html b/overrides/partials/nav.html
new file mode 100644
index 00000000..f9791f45
--- /dev/null
+++ b/overrides/partials/nav.html
@@ -0,0 +1,11 @@
+{#- This file was automatically generated - do not edit -#} {% import
+"partials/nav-item.html" as item with context %} {% set class = "md-nav
+md-nav--primary" %} {% if "navigation.tabs" in features %} {% set class = class
+~ " md-nav--lifted" %} {% endif %} {% if "toc.integrate" in features %} {% set
+class = class ~ " md-nav--integrated" %} {% endif %}
+