<p align="center">
<a href="https://www.qlcplus.org/" >
<img src="pages/01.basics/qlcplus.svg" alt="QLC+ Logo" title="qlcplus.png"  height="60" />
</a>
</p>

<h1 align="center">QLC+ Official Documentation</h1>

<p align="center">
    <a href="https://github.com/mcallegari/qlcplus-docs/actions" alt="Workflow">
        <img src="https://github.com/mcallegari/qlcplus-docs/actions/workflows/main.yml/badge.svg" /></a>
    <a href="https://observatory.mozilla.org/analyze/docs.qlcplus.org" alt="Mozilla HTTP Observatory Grade">
        <img src="https://img.shields.io/mozilla-observatory/grade-score/docs.qlcplus.org?publish" /></a>
    <a href="https://digitalbeacon.co/report/docs-qlcplus-org" alt="Beacon">
        <img src="https://img.shields.io/badge/dynamic/json?color=blue&label=Beacon&query=%24.co2&suffix=%20CO%E2%82%82%2Fview&url=https%3A%2F%2Fdigitalbeacon.co%2Fbadge%3Furl%3Dhttps%253A%252F%252Fdocs.qlcplus.org&cacheSeconds=604800" /></a>
    <a href="https://github.com/mcallegari/qlcplus-docs/issues" alt="Issues">
        <img src="https://img.shields.io/github/issues/mcallegari/qlcplus-docs" /></a>
    <a href="http://creativecommons.org/publicdomain/zero/1.0/" alt="License: CC0-1.0">
        <img src="https://img.shields.io/badge/License-CC0_1.0-lightgrey.svg" /></a>
</p>


<p align="center">
    <a href="https://docs.qlcplus.org/" alt="docs.qlcplus.org">
        <img src="https://img.shields.io/badge/View_Online-grey?style=for-the-badge&logo=aiohttp
        " /></a>
    <!-- BEGIN LATEST DOWNLOAD BUTTON -->
    <a href="https://www.qlcplus.org/downloads/4.14.0/QLC+_4.14.0_user_manual.pdf" alt="offline-pdf">
        <img src="https://custom-icon-badges.demolab.com/badge/-Download_PDF-blue?style=for-the-badge&logo=download&logoColor=white" /></a>
    <!-- END LATEST DOWNLOAD BUTTON -->
</p>


## Introduction
Welcome to the official documentation repository for [qlcplus](https://qlcplus.org/)!

The [docs.qlcplus.org](https://docs.qlcplus.org/) website uses the [Grav](https://getgrav.org/) content management system (CMS) and Learn2 with Git Sync plugin. This helps us to collaboratively edit our Markdown-based documentation. When changes are made to this repo the website automatically reflects the changes.

## Contributing

If you find a problem but don't have the time to fix it, you can [open an issue](https://github.com/mcallegari/qlcplus-docs/issues) to let us know about it. Otherwise expand the below instructions to edit a page right here in GitHub:
<details>
<summary>Edit a page directly</summary>

1. Click the ![edit this page](pages/01.basics/edit-this-page.png) link on the page of documentation you wish to improve. You'll be redirected to a preview in the GitHub editor. 
2. Click the pencil icon (Edit this file) on the top right of the preview. 
3. Edit the page
4. Click Commit Changes...
5. Give a quick summary of your proposed improvement through the commit message. The bellow is an example:
![Example commit message](pages/01.basics/commit-message.png)
6. Your changes will be reviewed and merged if they meet our guidelines.

</details>

## Translations
<details>
<summary>Steps to Add a New Translation</summary>

### 1. Prepare the Translation Files
1. Navigate to the [`/pages`](https://github.com/mcallegari/qlcplus-docs/tree/main/pages) directory of the repo.
2. Find the documentation you wish to translate
3. Duplicate the `.md` files (e.g., `chapter.v4.md`) for the new language.
4. Append the language code to the file names using an underscore (e.g., `chapter.v4_es.md`).

### 2. Translate the Content
1. Open the newly created language-specific `.md` files.
2. Replace the content with the translated text

</details>

## Support QLC+
If QLC+ helps you to make your lights shine, please consider donating or buying merch. Use these links to find out more:
<table>
<tr>
<td style="text-align:right">Sponsor the QLC+ project:</td>
<td style="text-align:left"><a href="https://github.com/sponsors/mcallegari"><img src="https://img.shields.io/badge/sponsor-30363D?logo=GitHub-Sponsors&logoColor=#white" /></a></td>
</tr>
<tr>
<td style="text-align:right">Donate via PayPal:</td>
<td style="text-align:left"><a href="https://www.paypal.me/mcallegariqlcplus"><img alt="Static Badge" src="https://img.shields.io/badge/PayPal-blue?logo=paypal">
</a></td>
</tr>
<tr>
<td style="text-align:right">Buy merch, themes and plugins:</td>
<td style="text-align:left"><a href="https://merch.qlcplus.org"><img alt="Static Badge" src="https://img.shields.io/badge/merch.qlcplus.org-d?logoColor=%23FFFFF"></a></td>
</tr>
</tbody>
</table>

## Join the Discussion
Engage with the QLC+ community in the [forums](https://www.qlcplus.org/forum/) or on social media to share your knowledge, ask questions, and collaborate with other users.

By contributing to the documentation, you're not only helping yourself but also supporting the QLC+ community. Together, we can create a comprehensive and reliable resource for lighting enthusiasts using QLC+.

---
<p align="center" xmlns:cc="http://creativecommons.org/ns#" xmlns:dct="http://purl.org/dc/terms/"><a property="dct:title" rel="cc:attributionURL" href="http://docs.qlcplus.org">QLC+ Offiical Documentation</a> by <a rel="cc:attributionURL dct:creator" property="cc:attributionName" href="http://qlcplus.org">Massimo Callegari</a> is marked with <a href="https://creativecommons.org/publicdomain/zero/1.0/?ref=chooser-v1" target="_blank" rel="license noopener noreferrer" style="display:inline-block;">CC0 1.0 Universal<img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/cc.svg?ref=chooser-v1" alt=""><img style="height:22px!important;margin-left:3px;vertical-align:text-bottom;" src="https://mirrors.creativecommons.org/presskit/icons/zero.svg?ref=chooser-v1" alt=""></a></p>


<p align="center">
    <a href="https://www.instagram.com/qlcplus/" alt="Instagram">
        <img src="https://img.shields.io/badge/Instagram-%23E4405F.svg?style=flat&logo=Instagram&logoColor=white" /></a>
    <a href="https://www.youtube.com/watch?v=I9bccwcYQpM&" alt="YouTube">
        <img src="https://img.shields.io/badge/YouTube-%23FF0000.svg?style=flat&logo=YouTube&logoColor=white" /></a>
    <a href="https://www.facebook.com/qlcplus" alt="Facebook">
        <img src="https://img.shields.io/badge/Facebook-%231877F2.svg?style=flat&logo=Facebook&logoColor=white" /></a>
</p>

<p align="center">
    
</p>