initial commit

Author: eMUQI

.github/dependabot.yml

@@ -0,0 +1,12 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"
+  

.github/workflows/deploy.yml

@@ -0,0 +1,43 @@
+name: Build and Deploy to Server
+
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - 'README.md'
+      - '.github/**'
+  workflow_dispatch:
+
+jobs:
+  build-and-deploy:
+    name: Build and Deploy
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repository
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v6
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Build website
+        run: npm run build
+
+      - name: Deploy to Server via rsync
+        uses: easingthemes/[email protected] 
+        with:
+          SSH_PRIVATE_KEY: ${{ secrets.SSH_PRIVATE_KEY }}
+          REMOTE_HOST: ${{ secrets.SSH_HOST }}
+          REMOTE_USER: ${{ secrets.SSH_USER }}
+          REMOTE_PORT: ${{ secrets.SSH_PORT }} 
+          SOURCE: "build/"
+          TARGET: ${{ secrets.TARGET_DIR }}
+          ARGS: "-avz --delete"

.github/workflows/pr-deploy-test.yml

@@ -0,0 +1,28 @@
+name: PR Build Test
+
+on:
+  pull_request:
+    branches:
+      - main
+    # Review gh actions docs if you want to further define triggers, paths, etc
+    # https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
+    paths-ignore:
+      - 'README.md'
+      - '.github/**'
+jobs:
+  test-deploy:
+    name: Test deployment
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 22
+          cache: npm
+
+      - name: Install dependencies
+        run: npm ci
+      - name: Test build website
+        run: npm run build

.github/workflows/pr-image-check.yml

@@ -0,0 +1,111 @@
+name: PR Image Format Check
+
+on:
+  pull_request:
+    types: [opened, synchronize, reopened]
+
+permissions:
+  pull-requests: write
+
+jobs:
+  check-images:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check for new images via API and comment
+        uses: actions/github-script@v7
+        with:
+          script: |
+            const issue_number = context.issue.number;
+            const owner = context.repo.owner;
+            const repo = context.repo.repo;
+            const botCommentIdentifier = "<!-- Image Format Check by GitHub Action -->";
+
+            console.log("Fetching files from PR via GitHub API...");
+            const files = await github.paginate(github.rest.pulls.listFiles, {
+              owner,
+              repo,
+              pull_number: issue_number,
+              per_page: 100,
+            });
+            
+            const newImages = files
+              .filter(file => file.status === 'added' && /\.(jpg|jpeg|png)$/i.test(file.filename))
+              .map(file => file.filename);
+
+            console.log("Searching for previous comments from this action...");
+            const { data: comments } = await github.rest.issues.listComments({
+              owner,
+              repo,
+              issue_number,
+            });
+
+            const botComments = comments.filter(comment => comment.body.includes(botCommentIdentifier));
+
+            if (botComments.length > 0) {
+              console.log(`Found ${botComments.length} old comment(s) to delete.`);
+              const deletePromises = botComments.map(comment =>
+                github.rest.issues.deleteComment({
+                  owner,
+                  repo,
+                  comment_id: comment.id,
+                })
+              );
+              await Promise.all(deletePromises);
+              console.log("Successfully deleted old comment(s).");
+            }
+
+            if (newImages.length > 0) {
+              console.log(`Found ${newImages.length} new JPG/JPEG/PNG images. Creating a new comment.`);
+              
+              const fileList = newImages.map(file => `- \`${file}\``).join('\n');
+              
+              // The body content is defined here without any leading whitespace on each line
+              // to ensure correct Markdown rendering in the final GitHub comment.
+              const bodyTemplate = `${botCommentIdentifier}
+              ### 🖼️ Image Format Check
+              
+              Hello! We've detected the following newly added JPG, JPEG, or PNG images in this pull request:
+              
+              ${fileList}
+              
+              For better web performance and smaller file sizes, please consider converting them to a more modern format like **WebP**.
+              
+              Thank you for your contribution! ✨
+
+              ---
+
+              <details>
+              <summary>💡How to Convert?</summary>
+
+              <br\>
+              
+              You can use Google's official \`cwebp\` command-line tool for conversion. It's efficient and powerful.
+              
+              <strong>Download \`cwebp\` Command-Line Tool</strong>
+              
+              You can download the pre-compiled toolkits: https://developers.google.com/speed/webp/download After downloading and extracting, you can find the \`cwebp\` executable in the \`bin\` directory.
+              
+              **Example Command:**
+              \`\`\`bash
+              # -q 80 sets the quality factor to 80 (0-100), a good balance between quality and file size.
+              cwebp -q 80 your_image.jpg -o your_image.webp
+              \`\`\`
+
+              </details>`
+              
+              ;
+
+              const body = bodyTemplate.split('\n').map(line => line.trimStart()).join('\n');
+
+              await github.rest.issues.createComment({
+                owner,
+                repo,
+                issue_number,
+                body,
+              });
+              console.log("Successfully created a new instructional comment.");
+
+            } else {
+              console.log("No new JPG/JPEG/PNG images found. No comment will be posted.");
+            }

.gitignore

@@ -0,0 +1,26 @@
+# Dependencies
+/node_modules
+
+# Production
+/build
+
+# Generated files
+.docusaurus
+.cache-loader
+
+# Misc
+.DS_Store
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# VS Code
+.vscode
+
+# Antigravity
+.agent

README.md

@@ -0,0 +1,42 @@
+# Waveshare Docs
+
+This repository contains the source code for the [Waveshare Docs Platform](https://docs.waveshare.com).
+
+Our goal is to continuously improve documentation quality, lower the learning curve for users, and make development simpler and more efficient.
+
+## Issue Reporting
+
+If you encounter any issues during use, please feel free to report them through the following methods:
+
+- Submit issues or suggestions on the [Issues](https://github.com/waveshareteam/Docs_en/issues/new) page of this project
+
+## Local Development
+
+This project is built with [Docusaurus](https://docusaurus.io/). Follow these steps to preview and build locally:
+
+```sh
+# Install dependencies
+npm ci
+
+# Start local preview
+npm run start
+
+# Build static files
+npm run build
+
+# Preview static files locally
+npm run serve
+```
+
+## Contribution Guide
+
+We welcome contributions to improve the documentation! Here is how you can help:
+
+1. **Fork the Repository** - Fork this repository to your GitHub account.
+2. **Local Modifications** - Clone the repository to your local machine and make your modifications.
+3. **Submit PR** - Create a Pull Request, detailing the content and purpose of your changes.
+4. **Await Merge** - We will review your PR and merge it once approved.
+
+---
+
+Thank you for supporting Waveshare Docs!

docs/ESP32/ESP32-C3/ESP32-C3-Zero/Arduino.md

@@ -0,0 +1,55 @@
+---
+sidebar_position: 2
+title: Arduino
+slug: /ESP32-C3-Zero/Development-Environment-Setup-Arduino
+product_family:
+  - ESP32
+product_model:
+  - ESP32-C3-Zero
+  - ESP32-C3-Zero-M
+  - ESP32-C3-Zero-Basic-Kit
+---
+
+import ArduinoTutorialIntro from '@site/docs/ESP32/snippets/ArduinoTutorialIntro.mdx';
+
+<!-- Image References -->
+import enableUsbcdc from './images/Enable-USBCDC.webp';
+import arduinoideEsp32c3zero from './images/ESP32-C3-Zero-Arduino.webp';
+
+# Arduino Development
+
+This chapter includes the following sections; please read according to your needs:
+
+- [Arduino Tutorial for Beginners](#arduino-tutorial-for-beginners)
+- [Environment Setup](#environment-setup)
+
+<ArduinoTutorialIntro />
+
+## Environment Setup
+
+### 1. Installing and Configuring Arduino IDE
+
+Please refer to the **[Arduino IDE Setup Tutorial](/docs/ESP32/Tutorials/Arduino-Tutorials/01-Arduino-IDE-Setup.md)** to download and install the Arduino IDE, and add ESP32 support.
+
+### 2. Additional Tips
+
+1. The ESP32-C3-Zero supports direct model selection in the Arduino IDE. Select "Waveshare ESP32-C3-Zero".
+   
+   <div style={{maxWidth:650}}> <img src={arduinoideEsp32c3zero} alt="Select ESP32-C3-Zero in Arduino IDE"/></div>
+
+2. The ESP32-C3-Zero uses the ESP32-C3 native USB interface, not UART-to-USB. For serial communication:
+
+   - The `printf()` function can be used directly;
+
+   - To use the `Serial.println()` function, you need to enable the USB CDC feature. Please follow the steps below to check and confirm that your environment is configured correctly:
+
+     1. Update ESP32 libraries: It is recommended to update the ESP32 board library in the Arduino IDE to **version 3.3.5 or higher**. Newer versions of the library have USB CDC enabled by default for this board.
+
+     2. Check configuration options: In the Arduino IDE "Tools" menu, check and confirm that the "USB CDC On Boot" option is set to "Enabled".
+
+        :::note
+        As shown below, the "USB CDC On Boot" option should be `Enabled` when correctly configured.
+   
+        <div style={{maxWidth:600}}> <img src={enableUsbcdc} alt="Enable usbcdc"/></div>
+   
+        :::

docs/ESP32/ESP32-C3/ESP32-C3-Zero/FAQ.md

@@ -0,0 +1,46 @@
+---
+sidebar_position: 5
+title: FAQ
+slug: /ESP32-C3-Zero/FAQ
+product_family:
+  - ESP32
+product_model:
+  - ESP32-C3-Zero
+  - ESP32-C3-Zero-M
+  - ESP32-C3-Zero-Basic-Kit
+---
+
+import Details from '@theme/Details';
+
+# Product FAQ
+
+<Details summary="Q: Can the ESP32-C3-Zero be powered via pins?" className="faq-details" open>
+
+A: Yes. When using an external power supply, you can input 3.7V~6V at the castellated hole marked with "5V".
+
+</Details>
+
+
+<Details summary="Q: Why is there no response after uploading a program to the ESP32-C3-Zero?" className="faq-details" open>
+
+A: Press the Reset button to restart the device and check if there is any output.
+
+</Details>
+
+
+<Details summary="Q: How do I perform hardware debugging and flashing on the ESP32-C3-Zero? Do I just connect it to the computer via the Type-C port?" className="faq-details" open>
+
+A: Yes. If flashing fails, hold down the BOOT button while connecting the device to the computer, and then release it.
+
+</Details>
+
+
+<Details summary="Q: Does the ESP32-C3-Zero support IPv6?" className="faq-details" open>
+
+A: Yes, the ESP32-C3 supports IPv6 and provides IPv6 example programs.
+
+</Details>
+
+<Details summary="Q: Why are the colors displayed incorrectly when controlling the onboard RGB LED (WS2812) of the ESP32-C3-Zero (e.g., setting it to red results in green)?" className="faq-details" open>
+  A: This is caused by a mismatch in the color data order. The color data format for the onboard LED of the ESP32-C3-Zero is RGB (Red-Green-Blue). To resolve this, please specify the color order parameter as RGB in the initialization settings of the driver library.
+</Details>