forked from Seeed-Studio/wiki-documents
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge branch 'docusaurus-version' of https://github.com/Love4yzp/wiki…
…-documents into docusaurus-version
- Loading branch information
Showing
81 changed files
with
7,479 additions
and
1,262 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,181 +1 @@ | ||
| ### Thank you for considering to contribute to our seeed-studio files! | ||
|
|
||
| You can check these steps to set up your own files management platform: | ||
|
|
||
| 1. Fork this repository into your GitHub. | ||
| 2. Clone the repository you forked to your coding device. | ||
| 3. Make your modifications, changing existed files or add new files. ---- for detailed local deployment / installation please check below instruction. | ||
| 4. Commit your modifications and push to your Github repository. | ||
| 5. Create a PR from the branch in your forked to seeed-studio's wiki-documents main branch. | ||
|
|
||
|
|
||
| ### | ||
|
|
||
| export PATH=$PATH:/home/w0x7ce/Desktop/node-v18.12.1-linux-x64/bin | ||
|
|
||
| ## Local Installation | ||
|
|
||
| [INSTALL LATEST LTS NODE](https://github.com/nodejs/release#release-schedule) | ||
|
|
||
| ```bash | ||
| curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add - | ||
| echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list | ||
| ``` | ||
|
|
||
| ```bash | ||
| sudo apt remove cmdtest | ||
| sudo apt update && sudo apt install yarn | ||
| ``` | ||
|
|
||
| ### Auto Install | ||
|
|
||
| ```bash | ||
| yarn | ||
| ``` | ||
| This command will help you install all the dependences in package.json | ||
|
|
||
|
|
||
| ```bash | ||
| yarn start | ||
| ``` | ||
|
|
||
| This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server. | ||
|
|
||
| ```bash | ||
| yarn build | ||
| ``` | ||
|
|
||
| This command generates static content into the `build` directory and can be served using any static contents hosting service. | ||
|
|
||
| ```bash title='Signed' | ||
| Signed-off-by: tianrking <tian.r.king@gmail.com> | ||
| ``` | ||
|
|
||
| ## Custom Install & Plugin Install | ||
|
|
||
| ### Mermaid | ||
|
|
||
| ```bash | ||
| yarn add @docusaurus/theme-mermaid | ||
| ``` | ||
|
|
||
| ### MDX | ||
|
|
||
| ```bash | ||
| yarn add remark-math@3 rehype-katex@4 | ||
| ``` | ||
|
|
||
| ### jq | ||
|
|
||
| ```bash | ||
| curl -O https://get.0install.net/0install.sh && chmod +x 0install.sh | ||
| sudo ./0install.sh install local | ||
| 0install add jq https://apps.0install.net/utils/jq.xml | ||
| ``` | ||
|
|
||
| ### algolia | ||
|
|
||
| ```bash | ||
| yarn add @docusaurus/theme-search-algolia | ||
| ``` | ||
|
|
||
| ### Math | ||
|
|
||
| ```bash | ||
| yarn add remark-math@3 rehype-katex@5 hast-util-is-element@1.1.0 | ||
| ``` | ||
|
|
||
| ### plugin-content-docs | ||
|
|
||
| ```bash | ||
| yarn add @docusaurus/plugin-content-docs | ||
| ``` | ||
|
|
||
| ### plugin-pwa | ||
|
|
||
| ```bash | ||
| yarn add @docusaurus/plugin-debug | ||
| yarn add @docusaurus/plugin-pwa | ||
| ``` | ||
|
|
||
| ### Git | ||
|
|
||
| #### Cache | ||
|
|
||
| ```bash | ||
| git config --global http.postBuffer 524288000 | ||
| ``` | ||
|
|
||
| #### Speed | ||
|
|
||
| ```bash | ||
| git config --global http.lowSpeedLimit 0 | ||
| git config --global http.lowSpeedTime 999999 | ||
| ``` | ||
|
|
||
| #### depth | ||
|
|
||
| ```bash | ||
| git clone --depth=1 http://xxx.git | ||
| git fetch --unshallow | ||
| ``` | ||
|
|
||
| #### gitignore | ||
|
|
||
| ```bash | ||
| git rm -r --cached . | ||
| git add . | ||
| git commit -m 'update .gitignore' | ||
| ``` | ||
|
|
||
|
|
||
| ## Develop | ||
|
|
||
| ### Offical Function | ||
|
|
||
| Using SSH: | ||
|
|
||
| ```bash | ||
| USE_SSH=true yarn deploy | ||
| ``` | ||
|
|
||
| Not using SSH: | ||
|
|
||
| ```bash | ||
| GIT_USER=<Your GitHub username> yarn deploy | ||
| ``` | ||
|
|
||
| If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch. | ||
|
|
||
| ### Custom Deployment (We Used) | ||
|
|
||
| #### SSH KEY | ||
|
|
||
| [GENERATE SSH KEY](https://docs.github.com/en/authentication/connecting-to-github-with-ssh/generating-a-new-ssh-key-and-adding-it-to-the-ssh-agent) | ||
|
|
||
| [Add SSH KEY](https://github.com/settings/keys) | ||
|
|
||
| [Github Actions](https://github.com/{$USER}/{Workspace}/settings/secrets/actions) | ||
|
|
||
| ### Problems | ||
|
|
||
| 1. [ERROR] Error: ENOSPC: System limit for number of file watchers reached | ||
|
|
||
| - insert the new value into the system config | ||
|
|
||
| ```bash | ||
| echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p | ||
|
|
||
| ``` | ||
|
|
||
| - check that the new value was applied | ||
|
|
||
| ```bash | ||
| cat /proc/sys/fs/inotify/max_user_watches | ||
| ``` | ||
|
|
||
| - config variable name (not runnable) | ||
|
|
||
| ```bash | ||
| fs.inotify.max_user_watches=524288 | ||
| ``` | ||
| We offer two different PR ways on the wiki platform. Please check the [Contributor Guide](https://wiki.seeedstudio.com/Contributor/). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,13 +1,104 @@ | ||
| # The Seeed Studio Files Management Platform | ||
|
|
||
| <p style={{textAlign: 'center'}}><img src="https://files.seeedstudio.com/wiki/seeed_logo/Wiki_Platform_GT_Logo.jpg" alt="pir" width={1000} height="auto" /></p> | ||
| [](https://wiki.seeedstudio.com/Getting_Started/) | ||
|
|
||
| Seeed Studio has dedicated to realizing interactive digital replica of our physical world, as being an IoT hardware partner since 2008. This is an open platform collecting all the wikis published by Seeed Studio, to show you the full picture of our efforts, natural environments digitization and outcome production. | ||
|
|
||
| This is the Github source files for Seeed Studio. | ||
|
|
||
| You can constantly receive updated data from sensors and sensors network, access computational resources with different edge computing power, display and manage information on cloud and chain in ways. | ||
| ## What does this Wiki Platform Cover? | ||
|
|
||
| We here present you our [current accomplishments](/Getting_Started) and solutions and we are looking for your [contributions](https://github.com/Seeed-Studio/wiki-documents/discussions/339). | ||
| This platform will focus on four main topics as shown in the sidebar, with up-to-date information on all of our products. | ||
|
|
||
| You can [set up](https://wiki.seeedstudio.com/Deploy_Page_Locally) this platform locally. | ||
| - [Sensors and Sensing](https://wiki.seeedstudio.com/Sensor_Network/) | ||
| - [Networking](https://wiki.seeedstudio.com/Network/) | ||
| - [Edge Computing](https://wiki.seeedstudio.com/Edge_Computing/) | ||
| - [Cloud Services](https://wiki.seeedstudio.com/Cloud/) | ||
| - [Browser-based AI Solution](https://sensecraft.seeed.cc/ai/#/model) | ||
| - [Technology Topics](https://wiki.seeedstudio.com/topicintroduction/) | ||
| - [Contributor Program](https://wiki.seeedstudio.com/Contributor/) | ||
| - [Weekly Wiki](https://wiki.seeedstudio.com/weekly_wiki/) | ||
|
|
||
| [](https://wiki.seeedstudio.com/Getting_Started/) | ||
|
|
||
| ## Quick Links | ||
|
|
||
| Thanks for our [contributors](https://wiki.seeedstudio.com/contributors/), the collection pages are done and here are the quick links: | ||
|
|
||
| ### Sensor and Sensing | ||
|
|
||
| - [Grove Ecosystem](https://wiki.seeedstudio.com/Grove_System/) | ||
| - [SenseCAP Ecosystem](https://wiki.seeedstudio.com/SenseCAP_introduction/) | ||
| - [XIAO Series](https://wiki.seeedstudio.com/SeeedStudio_XIAO_Series_Introduction/) | ||
| - [Wio Terminal](https://wiki.seeedstudio.com/Wio_Terminal_Intro/) | ||
|
|
||
| [](https://wiki.seeedstudio.com/SeeedStudio_XIAO_Series_Introduction/) | ||
|
|
||
| ### Networking | ||
|
|
||
| - [Meshtastic Network](https://wiki.seeedstudio.com/meshtastic_introduction/) | ||
| - [SenseCAP Gateway](https://wiki.seeedstudio.com/Network/SenseCAP_Network/SenseCAP_Gateway_Intro/) | ||
| - [Raspberry Pi Network Solution - reRouter](https://wiki.seeedstudio.com/reRouter_Intro/) | ||
| - [Rockchip Netowrking Solutions](https://wiki.seeedstudio.com/Rockchip_network_solutions/) | ||
|
|
||
| [](https://wiki.seeedstudio.com/meshtastic_introduction/) | ||
|
|
||
| ### Edge Computing | ||
|
|
||
| - [Raspberry Pi-related Devices](https://wiki.seeedstudio.com/raspberry-pi-devices/) | ||
| - [NVIDIA Jetson®-related Devices](https://wiki.seeedstudio.com/NVIDIA_Jetson/) | ||
| - [ESP-powered Controller](https://wiki.seeedstudio.com/Edgebox-ESP-100-Arduino/) | ||
| - [BeagleBone®](https://wiki.seeedstudio.com/BeagleBone/) | ||
| - [ODYSSEY](https://wiki.seeedstudio.com/ODYSSEY_Intro/) | ||
|
|
||
| [](https://wiki.seeedstudio.com/NVIDIA_Jetson/) | ||
|
|
||
| ### Cloud | ||
|
|
||
| - [SenseCAP Dashboard](https://wiki.seeedstudio.com/Cloud_Chain/SenseCAP_Dashboard/Dashboard_Basics/) | ||
| - [SenseCAP API](https://wiki.seeedstudio.com/Cloud_Chain/SenseCAP_API/SenseCAP_API_Introduction/) | ||
| - [SenseCraft AI](https://wiki.seeedstudio.com/sensecraft_ai/) | ||
|
|
||
| [](https://wiki.seeedstudio.com/sensecraft_ai/) | ||
|
|
||
| ### Technology Topics and Popular Platforms | ||
|
|
||
| - [Home Assistant](https://wiki.seeedstudio.com/home_assistant_topic/) | ||
| - [TinyML](https://wiki.seeedstudio.com/tinyml_topic/) | ||
| - [Open Source](https://wiki.seeedstudio.com/open_source_topic/) | ||
| - [Edge AI](https://wiki.seeedstudio.com/edge_ai_topic/) | ||
| - [Arduino](https://wiki.seeedstudio.com/Arduino/) | ||
| - [Raspberry Pi](https://wiki.seeedstudio.com/Raspberry_Pi/) | ||
| - [Micro:bit](https://wiki.seeedstudio.com/microbit_wiki_page/) | ||
|
|
||
| [](https://wiki.seeedstudio.com/home_assistant_topic/) | ||
|
|
||
| ## Contributions | ||
|
|
||
| In Seeed, we greatly value our community of Seeeders. The [Seeed Studio Contributor Program](https://wiki.seeedstudio.com/Contributor/) is a collaborative program launched to unite our dear friends from all over the world and co-build innovative solutions together. | ||
|
|
||
| - [Pull Request Guide](https://wiki.seeedstudio.com/Contribution-Guide/) | ||
| - [Full steps to PR](https://wiki.seeedstudio.com/full_steps_pull_request/) - Able to [see the changes locally](https://wiki.seeedstudio.com/Deploy_Page_Locally) | ||
| - [Quick steps to PR](https://wiki.seeedstudio.com/quick_pull_request/) - Direct upload with md files and images. | ||
|
|
||
| [](https://wiki.seeedstudio.com/Contributor/) | ||
|
|
||
| ### More about Collaborative Programs | ||
|
|
||
| - [The Ranger Program](https://wiki.seeedstudio.com/ranger/) | ||
| - [The Contributor Program](https://wiki.seeedstudio.com/contributors/) | ||
| - [Apply for Rangers](https://docs.google.com/forms/d/e/1FAIpQLSdiAWHmRJqgVNTJyJDkzhufc1dygFyhWFyEtUTm-mrgSKaEgg/viewform) | ||
| - [Direct to Assignment](https://github.com/orgs/Seeed-Studio/projects/6) | ||
| - [More information to Rangers](https://www.seeedstudio.com/blog/2023/09/15/join-the-seeed-ranger-program-empowering-developers-and-building-communities/) | ||
| - [More information to Contributors](https://wiki.seeedstudio.com/Contributor/) | ||
|
|
||
| [](https://github.com/orgs/Seeed-Studio/projects/6) | ||
|
|
||
| ## Tech Support & Product Discussion | ||
|
|
||
| Thank you for choosing our products! We provide many forms of 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. | ||
|
|
||
| - [Forum](https://forum.seeedstudio.com/) - Ideas Exchange | ||
| - [Email](https://www.seeedstudio.com/contacts) - Expert Supports | ||
| - [Discord](https://discord.com/invite/eWkprNDMU7) - Collective Chatting | ||
| - [GitHub Discussion](https://github.com/Seeed-Studio/wiki-documents/discussions/69) - Wiki Suggestions |
Empty file.
Oops, something went wrong.