Skip to content

Commit

Permalink
optimize doc
Browse files Browse the repository at this point in the history
  • Loading branch information
@Neutree
Neutree committed Apr 2, 2024
1 parent dcc76f8 commit 67c51e5
Show file tree
Hide file tree
Showing 8 changed files with 873 additions and 89 deletions.
20 changes: 11 additions & 9 deletions maixpy/en/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,14 +183,14 @@ <h2>MaixPy</h2>
<h1><span>MaixPy (v4)</span></h1>
<h3>Easily create AI projects with Python on edge device</h3>
</div>
<div id="big_btn_wrapper" class="text-center p-4">
<a class="btn" href="/maixpy/doc/en/index.html">Quick Start 🚀📖</a>
<a class="btn" href="/maixpy/api/">API Reference 📚</a>
<a class="btn" target="_blank" href="https://wiki.sipeed.com/maixcam">Hardware：MaixCAM 📷</a>
<a class="btn" target="_blank" href="https://github.com/sipeed/maixpy">Source Code ⭐️</a>
<div id="big_btn_wrapper" class="flex flex-wrap justify-center items-center">
<a class="btn m-1" href="/maixpy/doc/en/index.html">Quick Start 🚀📖</a>
<a class="btn m-1" href="/maixpy/api/">API Reference 📚</a>
<a class="btn m-1" target="_blank" href="https://wiki.sipeed.com/maixcam">Hardware：MaixCAM 📷</a>
<a class="btn m-1" target="_blank" href="https://github.com/sipeed/maixpy">Source Code ⭐️</a>
</div>
<div class="flex justify-center" id="tags">
<p><a href="https://github.com/sipeed/MaixPy/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/sipeed/MaixPy?style=social" alt="GitHub Repo stars" /></a><a href="%22https://github.com/sipeed/MaixPy/blob/main/LICENSE.html" target="_blank"><img src="https://img.shields.io/badge/license-Apache%20v2.0-orange.svg" alt="Apache 2.0" /></a><a href="https://pypi.python.org/pypi/maixpy/" target="_blank"><img src="https://img.shields.io/pypi/v/maixpy.svg" alt="PyPI" /></a><a href="https://pypi.org/project/maixpy/" target="_blank"><img src="https://img.shields.io/pypi/dm/maixpy?label=pypi%20downloads" alt="PyPI - Downloads" /></a><img src="https://img.shields.io/github/repo-size/sipeed/maixpy" alt="GitHub repo size" /> <a href="https://github.com/sipeed/MaixPy/actions/workflows/build_maixcam.yml" target="_blank"><img src="https://github.com/sipeed/MaixPy/actions/workflows/build_maixcam.yml/badge.svg" alt="Build MaixCAM" /></a><a href="https://github.com/sipeed/MaixPy/actions/workflows/trigger_wiki.yml" target="_blank"><img src="https://github.com/sipeed/MaixPy/actions/workflows/trigger_wiki.yml/badge.svg" alt="Trigger wiki" /></a></p>
<p><a href="https://github.com/sipeed/MaixPy" target="_blank"><img src="https://img.shields.io/github/stars/sipeed/MaixPy?style=social" alt="GitHub Repo stars" /></a><a href="%22https://github.com/sipeed/MaixPy/blob/main/LICENSE.html" target="_blank"><img src="https://img.shields.io/badge/license-Apache%20v2.0-orange.svg" alt="Apache 2.0" /></a><a href="https://pypi.python.org/pypi/maixpy/" target="_blank"><img src="https://img.shields.io/pypi/v/maixpy.svg" alt="PyPI" /></a><a href="https://pypi.org/project/maixpy/" target="_blank"><img src="https://img.shields.io/pypi/dm/maixpy?label=pypi%20downloads" alt="PyPI - Downloads" /></a><a href="https://github.com/sipeed/MaixPy" target="_blank"><img src="https://img.shields.io/github/repo-size/sipeed/maixpy" alt="GitHub repo size" /></a> <a href="https://github.com/sipeed/MaixPy/actions/workflows/build_maixcam.yml" target="_blank"><img src="https://github.com/sipeed/MaixPy/actions/workflows/build_maixcam.yml/badge.svg" alt="Build MaixCAM" /></a><a href="https://github.com/sipeed/MaixPy/actions/workflows/trigger_wiki.yml" target="_blank"><img src="https://github.com/sipeed/MaixPy/actions/workflows/trigger_wiki.yml/badge.svg" alt="Trigger wiki" /></a></p>
</div>
<div class="text-center">
<p>English | <a href="/maixpy/" >中文</a></p>
Expand All @@ -202,7 +202,7 @@ <h3>Easily create AI projects with Python on edge device</h3>
</blockquote>
<div class="mt-6"></div>
<div id="id1" class="flex flex-row justify-start flex-wrap">
<div>
<div class="w-full">
<h2>Easy-to-use API, AI vision classify in 10 lines</h2>

<pre class="language-python"><code class="language-python">from maix import camera, display, image, nn
Expand All @@ -225,9 +225,10 @@ <h2>Easy-to-use API, AI vision classify in 10 lines</h2>
</video>
</div> <!-- id1 -->
<!-- div start-->
<div class="w-full">
<h2>Hardware peripheral control:</h2>
<div class="flex flex-row justify-start flex-wrap">
<div class="mr-4">
<div class="w-full mr-4">
<p>Serial send and receive:</p>

<pre class="language-python"><code class="language-python">from maix import uart
Expand All @@ -239,7 +240,7 @@ <h2>Hardware peripheral control:</h2>
print(&quot;received:&quot;, serial.read(timeout = 2000))
</code></pre>
</div>
<div>
<div class="w-full">
<p>I2C send and receive:</p>

<pre class="language-python"><code class="language-python">from maix import i2c
Expand All @@ -252,6 +253,7 @@ <h2>Hardware peripheral control:</h2>
</code></pre>
</div>
</div>
</div>
<!-- div end-->
<!-- start -->
<h2>MaixVision Workstation</h2>
Expand Down
22 changes: 12 additions & 10 deletions maixpy/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -183,14 +183,14 @@ <h2>MaixPy</h2>
<h1><span>MaixPy (v4)</span></h1>
<h3>快速落地 AI 视觉、听觉应用</h3>
</div>
<div id="big_btn_wrapper" class="text-center p-4">
<a class="btn" href="/maixpy/doc/zh/index.html">快速开始 🚀📖</a>
<a class="btn" href="/maixpy/api/">API 参考 📚</a>
<a class="btn" target="_blank" href="https://wiki.sipeed.com/maixcam">硬件平台：MaixCAM 📷</a>
<a class="btn" target="_blank" href="https://github.com/sipeed/maixpy">开源仓库 ⭐️</a>
<div id="big_btn_wrapper" class="flex flex-wrap justify-center items-center">
<a class="btn m-1" href="/maixpy/doc/zh/index.html">快速开始 🚀📖</a>
<a class="btn m-1" href="/maixpy/api/">API 参考 📚</a>
<a class="btn m-1" target="_blank" href="https://wiki.sipeed.com/maixcam">硬件平台：MaixCAM 📷</a>
<a class="btn m-1" target="_blank" href="https://github.com/sipeed/maixpy">开源仓库 ⭐️</a>
</div>
<div class="flex justify-center" id="tags">
<p><a href="https://github.com/sipeed/MaixPy/stargazers" target="_blank"><img src="https://img.shields.io/github/stars/sipeed/MaixPy?style=social" alt="GitHub Repo stars" /></a><a href="%22https://github.com/sipeed/MaixPy/blob/main/LICENSE.html" target="_blank"><img src="https://img.shields.io/badge/license-Apache%20v2.0-orange.svg" alt="Apache 2.0" /></a><a href="https://pypi.python.org/pypi/maixpy/" target="_blank"><img src="https://img.shields.io/pypi/v/maixpy.svg" alt="PyPI" /></a><a href="https://pypi.org/project/maixpy/" target="_blank"><img src="https://img.shields.io/pypi/dm/maixpy?label=pypi%20downloads" alt="PyPI - Downloads" /></a><img src="https://img.shields.io/github/repo-size/sipeed/maixpy" alt="GitHub repo size" /> <a href="https://github.com/sipeed/MaixPy/actions/workflows/build_maixcam.yml" target="_blank"><img src="https://github.com/sipeed/MaixPy/actions/workflows/build_maixcam.yml/badge.svg" alt="Build MaixCAM" /></a><a href="https://github.com/sipeed/MaixPy/actions/workflows/trigger_wiki.yml" target="_blank"><img src="https://github.com/sipeed/MaixPy/actions/workflows/trigger_wiki.yml/badge.svg" alt="Trigger wiki" /></a></p>
<p><a href="https://github.com/sipeed/MaixPy" target="_blank"><img src="https://img.shields.io/github/stars/sipeed/MaixPy?style=social" alt="GitHub Repo stars" /></a><a href="%22https://github.com/sipeed/MaixPy/blob/main/LICENSE.html" target="_blank"><img src="https://img.shields.io/badge/license-Apache%20v2.0-orange.svg" alt="Apache 2.0" /></a><a href="https://pypi.python.org/pypi/maixpy/" target="_blank"><img src="https://img.shields.io/pypi/v/maixpy.svg" alt="PyPI" /></a><a href="https://pypi.org/project/maixpy/" target="_blank"><img src="https://img.shields.io/pypi/dm/maixpy?label=pypi%20downloads" alt="PyPI - Downloads" /></a><a href="https://github.com/sipeed/MaixPy" target="_blank"><img src="https://img.shields.io/github/repo-size/sipeed/maixpy" alt="GitHub repo size" /></a> <a href="https://github.com/sipeed/MaixPy/actions/workflows/build_maixcam.yml" target="_blank"><img src="https://github.com/sipeed/MaixPy/actions/workflows/build_maixcam.yml/badge.svg" alt="Build MaixCAM" /></a><a href="https://github.com/sipeed/MaixPy/actions/workflows/trigger_wiki.yml" target="_blank"><img src="https://github.com/sipeed/MaixPy/actions/workflows/trigger_wiki.yml/badge.svg" alt="Trigger wiki" /></a></p>
</div>
<div class="text-center">
<p><a href="./en/" >English</a> | 中文</p>
Expand All @@ -202,7 +202,7 @@ <h3>快速落地 AI 视觉、听觉应用</h3>
</blockquote>
<div class="mt-6"></div>
<div id="id1" class="flex flex-row justify-start flex-wrap">
<div>
<div class="w-full">
<h2>简易的 API 设计， 10 行代码进行 AI 图像识别：</h2>

<pre class="language-python"><code class="language-python">from maix import camera, display, image, nn
Expand All @@ -225,9 +225,10 @@ <h2>简易的 API 设计， 10 行代码进行 AI 图像识别：</h2>
</video>
</div> <!-- id1 -->
<!-- div start-->
<div class="w-full">
<h2>硬件外设控制，不在话下：</h2>
<div class="flex flex-row justify-start flex-wrap">
<div class="mr-4">
<div class="w-full flex flex-row justify-start flex-wrap">
<div class="w-full mr-4">
<p>串口收发：</p>

<pre class="language-python"><code class="language-python">from maix import uart
Expand All @@ -239,7 +240,7 @@ <h2>硬件外设控制，不在话下：</h2>
print(&quot;received:&quot;, serial.read(timeout = 2000))
</code></pre>
</div>
<div>
<div class="w-full">
<p>I2C 收发：</p>

<pre class="language-python"><code class="language-python">from maix import i2c
Expand All @@ -252,6 +253,7 @@ <h2>硬件外设控制，不在话下：</h2>
</code></pre>
</div>
</div>
</div>
<!-- div end-->
<!-- start -->
<h2>便捷的 MaixVision 工作站</h2>
Expand Down
Loading

0 comments on commit 67c51e5

Please sign in to comment.