Skip to content

Commit c405ea4

Browse files
committed
optimize quick start
1 parent d1b9c20 commit c405ea4

File tree

4 files changed

+15
-6
lines changed

4 files changed

+15
-6
lines changed

docs/get_started/en/usage/quick_start.md

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,13 @@ For example, on `Ubuntu`:
1616
sudo apt install python3 python3-pip git
1717
```
1818

19-
`Windows` and `macOS` please go to [Official Website Download](https://www.python.org/downloads/)
19+
For **Windows** and **macOS**, please visit the [official website](https://www.python.org/downloads/) to download Python.
20+
**During installation, make sure to check the option** `Add python.exe to PATH`.
21+
22+
Then, open a new terminal (on **Windows**, press `Ctrl+R`, type `cmd`, and press Enter):
23+
24+
1. Type `python --version`. If you see something like `Python 3.**.**`, it means Python has been successfully installed.
25+
2. Type `pip --version`. If you see something like `pip **.*.*`, it means the `pip` tool has been successfully installed.
2026

2127

2228
## Install teedoc

docs/get_started/en/usage/sites.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ desc: teedoc, convert markdown or jupyter notbook into html static webpage, use
88
| Site | Brief | Site source doc |
99
| ---- | ----- | ----------- |
1010
| [teedoc official website](https://teedoc.github.io) | a useful documentation website generator | [teedoc/teedoc.github.io](https://github.com/teedoc/teedoc.github.io) |
11-
| [MaixPy](https://maixpy.sipeed.com) | Edge AI Computing Python SDK | [sipeed/MaixPy_DOC](https://github.com/sipeed/MaixPy_DOC) |
11+
| [MaixPy](https://wiki.sipeed.com/maixpy/) | Edge AI Computing Python SDK | [sipeed/MaixPy_DOC](https://github.com/sipeed/MaixPy/tree/main/docs) |
1212
| [Sipeed Wiki](https://wiki.sipeed.com) | Sipeed Official Wiki | [sipeed/sipeed_wiki](https://github.com/sipeed/sipeed_wiki) |
1313
| [teedoc.github.io/re0-web-teedoc/](https://teedoc.github.io/re0-web-teedoc/) | example site converted from gitbook site | [teedoc/re0-web-teedoc](https://github.com/teedoc/re0-web-teedoc) |
1414
| [QuecPython](https://python.quectel.com/doc/) | QuecPython documentation center | [gitee](https://gitee.com/quecpython/Community-document) [github](https://github.com/quecpython/Community-document) |
1515
| [BPI Steam Doc](https://bpi-steam.com/) | BananaPi, Steam team documentation (Wiki), including open source software and open source hardware information, AIOT information, etc. | [BPI-STEAM/BPI-Doc](https://github.com/BPI-STEAM/BPI-Doc) |
1616
| [udbg](https://udbg.github.io/) | Dynamic binary analysis tools based on Lua | [udbg/udbg.github.io](https://github.com/udbg/udbg.github.io) |
17-
| [VastUtils](https://sakurajimamaii.github.io/VastDocs/) | Easy Quick Android Utils for you to faster project development | [SakurajimaMaii/VastDocs](https://github.com/SakurajimaMaii/VastDocs) |
17+
1818

1919

2020
Looking forward to your use, welcome to [submit issue](https://github.com/teedoc/teedoc.github.io/issues) or PR to add your website

docs/get_started/zh/usage/quick_start.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,11 @@ desc: teedoc, 将 markdown 或者 jupyter notbook 转换成 html 静态网页
1616
sudo apt install python3 python3-pip git
1717
```
1818

19-
`Windows``macOS`请到[官网下载](https://www.python.org/downloads/)
19+
`Windows``macOS`请到[官网下载](https://www.python.org/downloads/)**安装时注意勾上`将 python.exe 加入到系统环境变量(PATH)`选项**
20+
21+
然后新打开一个终端(`Windows``Ctrl+R`输入`cmd`) :
22+
1. 输入`python --version`,能看到`Python 3.**.**`这样的字样就代表 `Python` 安装成功了。
23+
2. 输入`pip --version`,能看到`pip **.*.*`这样的字样就代表 `pip` 工具安装成功了。
2024

2125

2226
## 安装 teedoc

docs/get_started/zh/usage/sites.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,13 +7,12 @@ desc: teedoc, 将 markdown 或者 jupyter notbook 转换成 html 静态网页
77
| 网站 | 简介 | 站点源文档 |
88
| ---- | --- | --- |
99
|[teedoc 官网](https://teedoc.github.io) | 好用的文档网站生成工具 | [teedoc/teedoc.github.io](https://github.com/teedoc/teedoc.github.io) |
10-
|[MaixPy](https://maixpy.sipeed.com) | 边缘 AI 计算 Python SDK | [sipeed/MaixPy_DOC](https://github.com/sipeed/MaixPy_DOC) |
10+
|[MaixPy](https://wiki.sipeed.com/maixpy/) | 边缘 AI 计算 Python SDK | [sipeed/MaixPy_DOC](https://github.com/sipeed/MaixPy/tree/main/docs) |
1111
|[Sipeed Wiki](https://wiki.sipeed.com) | Sipeed 官方Wiki | [sipeed/sipeed_wiki](https://github.com/sipeed/sipeed_wiki) |
1212
|[teedoc.github.io/re0-web-teedoc/](https://teedoc.github.io/re0-web-teedoc/) | 从 gitbook 转到 teedoc 的示例网站 | [teedoc/re0-web-teedoc](https://github.com/teedoc/re0-web-teedoc) |
1313
|[QuecPython](https://python.quectel.com/doc/) | QuecPython 文档中心 | [gitee](https://gitee.com/quecpython/Community-document) [github](https://github.com/quecpython/Community-document) |
1414
| [BPI Steam Doc](https://bpi-steam.com/) | BananaPi, Steam团队的文档(Wiki),包含了开源软件和开源硬件资料,AIOT资料等等 | [BPI-STEAM/BPI-Doc](https://github.com/BPI-STEAM/BPI-Doc) |
1515
| [udbg](https://udbg.github.io/) | 基于Lua的二进制调试/分析工具 | [udbg/udbg.github.io](https://github.com/udbg/udbg.github.io) |
16-
| [VastUtils](https://sakurajimamaii.github.io/VastDocs/) | 一款加快你安卓开发的安卓工具集 | [SakurajimaMaii/VastDocs](https://github.com/SakurajimaMaii/VastDocs) |
1716

1817
期待你的使用, 欢迎[提交 issue](https://github.com/teedoc/teedoc.github.io/issues) 或者 PR 来添加你的网站
1918

0 commit comments

Comments
 (0)