The official documentation page for the WLED project!
To live page
Community improvements are encouraged! Just click the little pencil mark on the page you'd like to change and submit a pull request.
If you'd like to do more advanced changes (e.g. adding a page), the Material for MkDocs documentation is very helpful.
If possible, it is preferable to store image content within this repository at /docs/assets/images/content. With external links, there is always a chance that the resource is deleted accidentally by the external hoster.
Let’s consider an example. Let’s imagine we want to add a page called Top 5 mistakes in section Basics after the Getting Started page. This page already exists, so you can already see the results in WLED Docs, but let’s imagine the page is not there and we will go steps needed to add it:
- Create a file that should contain the documentation. As we want to place the new page in section
Basicsit makes sense to put this file in subfolderdocs/basics/. In our example we call the filetop5_mistakes.md. You can use another .md file as an example. Important is to have the following few lines at the beginning of the file:
---
title: TOP 5 mistakes
hide:
# - navigation
# - toc
---
Don’t forget to adapt the title.
- Edit
mkdocs.ymlfile. Take care that indentations play an important role in .yml files. Go tonav:section in this file and add a new line after the line- Getting Started: basics/getting-started.mdas we want to add a new page after theGetting Startedpage. The new line must have the same indentation as the previous line and the content is- Top 5 mistakes: basics/top5_mistakes.md. By this we say that the new page must be calledTop 5 mistakesand its content is in the filetop5_mistakes.mdwe created before in subfolderbasics. That is!
It is even easier. Take a look at nav: section in mkdoks.yml file. To add a new section you just have to add a new line at a position where the new section must be. Then write a section name like this: - Compatibility:. TAKE
58FD
CARE on indentations! After this line you can then add new pages as described above.
You would need to install some tools:
- WEB Server. The probably easiest way is to use XAMPP to run local WEB server on your PC/Laptop. After installing you would need to start XAMPP Control Panel and run Apache Server. In the folder where XAMPP is installed to you will find a subfolder called
htdocs. This is the content of the WEB Server and you have to put WLED Docs web pages there, for example in subfolder calledwled-docs. Later, after generating pages using mkdocs, you will be able to access them viahttp://localhost/wled-docs/site/ - Python
- MkDocs
Now you can downlaod WLED Docs sources from the repository to subfolder wled-docs in the folder htdocs in your XAMPP installation (or if you have git installed you can use git command to clone like git clone --branch main https://github.com/Aircoookie/WLED-Docs). To "compile" the resulting web pages you have to run mkdocs build command in the wled-docs folder using command line. It generates subfolder 'site' with the resulting web pages and you can access them in your browser via http://localhost/wled-docs/site/