wled/wled-docs

This repository contains the written documentation for WLED, a popular open-source project that lets people control LED light strips and other addressable LEDs. The live documentation site lives at kno.wled.ge, and this repository is where all of that content is written, organized, and maintained. Think of it as the instruction manual and help center for anyone using WLED to create custom lighting projects. The project is built using a documentation tool called MkDocs, which takes plain text files written in a simple formatting language and turns them into a searchable, navigable website. The repository holds all of those text files, along with a configuration file that defines the structure and order of the pages. Community members are encouraged to contribute by clicking a small pencil icon on any documentation page to suggest edits or fixes directly. The primary users of this repository are WLED enthusiasts and contributors who want to improve the documentation. For example, if someone figured out how to connect a specific LED strip model that is not covered in the guides, they could add a new page explaining the setup process. The README provides step-by-step instructions for adding pages and sections, making it approachable even for non-developers who just want to share what they learned. One practical detail worth noting is the preference for storing images directly in the repository rather than linking to external sites. This avoids broken image links if an external host deletes the file. For those who want to preview changes before submitting them, the README explains how to run the documentation site locally, offering both a Docker-based approach and a Python-based alternative.