Project Overview
This is just the basic guideline for writing a Wiki, including the common writing code.
This is the overview for this wiki. It should contain these contents:
- Application shown display diagram or pictures of mainly used products
- Application principle
- Brief introduction to the Project
Hardware Preparation
I am using (Seeed Products) as the hardware here. The contents here should include:
- List all the products used in the Seeed Studio, with horizontal table written with text, plus "Get One Now" product link. The example code is shown below.
- Use graphics to show the hardware connection method of the project
Seeed Studio XIAO ESP32S3(example) | Seeed Studio Grove OLED Display 0.96(example) |
---|---|
Software Preparation
I am using Thonny IDE software(Windows) and some related libraries and files. The contents here should include:
- Application software and download address
- Open the software and install necessary dependencies or libraries
Arduino IDE | related files(libraries) |
---|---|
Getting Started
Step by step description: How is the project implemented
- Upload the first step code to a certain product, and the effect appears
- Upload the second step code to a product, and the effect appears
- ...
What's more
Something you want to add up, something you want to extend, like:
- The extension of this application
- Open up the field
- Offer expanded thinking
Trouble Shooting
Some problems might encounter in the process of hardware connection, software debugging or uploading.
Tech Support & Product Discussion
Thank you for choosing our products! We are here to provide you with different support to ensure that your experience with our products is as smooth as possible. We offer several communication channels to cater to different preferences and needs.
✨ The other wiki feature code
Code at the first(mandatory)
---
description: // One sentence introduction of the project
title: // One short words introduction of the project
keywords:
//Enter the upper-level directory where the file is stored (Grove,SenseCAP,reTerminal...)
image: https://files.seeedstudio.com/wiki/wiki-platform/S.png
slug: / The name of file
last_update:
date: //The data finished wiki
author: // author
---
The picture code
<p style={{textAlign: 'center'}}><img src="image_link" alt="pir" width={600} height="auto" /></p>
Video code
<div class="table-center">
<iframe width="100%" height="315" src="URL" scrolling="no" border="0" frameborder="no" framespacing="0" allowfullscreen="true"> </iframe>
</div>
Hyperlink
<a href="link" target="_blank"><span> PDF Download of SenseCAP S210X Sereis User Guide</span></a>
Highlight code
{code}
Hide the code
title here
#include
Print "code here"
Download Arduino IDEBbutton
Download Github Library Button
Table code
There includes hyperlinks, image links, table title
Sensor | Gas Type | Get One Now |
MQ2 | Combustible Gas, Smoke | |
1 | 2 | 3 |
note
Some content with Markdown syntax
. Check this api
.
tip
Some content with Markdown syntax
. Check this api
.
info
Some content with Markdown syntax
. Check this api
.
danger
Some content with Markdown syntax
. Check this api
.
Caution
Some content with Markdown syntax
. Check this api
.