{"repo":"wled/WLED-Docs","free":true,"listed":false,"github":"https://github.com/wled/WLED-Docs","clone":"git clone https://github.com/wled/WLED-Docs.git","description":"Documentation for the WLED project (kno.wled.ge)","language":null,"stars":153,"topics":["docs","hacktoberfest","knowledge-base","mkdocs","wled"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"knoWLEDge 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. Images 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. How to add a new page 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 over the steps needed to add it: 1. Create a file that should contain the documentation. As we want to place the new page in section Basics it makes sense to put this file in subfolder docs/basics/ . In our example we call the file top5 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: Don’t forget to adapt the title. 2. Edit mkdocs.yml file. Take care that indentations play an important role in .yml files. Go to nav: section in this file and add a new line after the line - Getting Started: basics/getting-started.md as we want to add a new page after the Getting Star","default_branch":null,"files":null,"tree":[],"storefront":"/r/wled","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/wled/WLED-Docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}