Skip to content

Commit 14debef

Browse files
committed
[update]
1 parent 0587227 commit 14debef

3 files changed

Lines changed: 34 additions & 86 deletions

File tree

README.md

Lines changed: 7 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -1,44 +1,11 @@
1-
# python-入门文档
1+
# Python 入门文档
22

3-
The Site is generated using [vuepress](https://vuepress.vuejs.org/) and [vuepress-theme-plume](https://github.com/pengzhanbo/vuepress-theme-plume)
3+
这是一个新手友好的 Python 3 入门文档,
44

5-
## Install
5+
要阅读本文档,请前往 <https://python.yxzl.dev/>
66

7-
```sh
8-
pnpm i
9-
```
10-
:::
7+
更多内容:
118

12-
## Usage
13-
14-
```sh
15-
# start dev server
16-
pnpm docs:dev
17-
# build for production
18-
pnpm docs:build
19-
# preview production build in local
20-
pnpm docs:preview
21-
# update vuepress and theme
22-
pnpm vp-update
23-
```
24-
:::
25-
26-
## Deploy to GitHub Pages
27-
28-
The plume theme has been created with GitHub Actions: `.github/workflows/docs-deploy.yml`. You also need to make the following settings in the GitHub repository:
29-
30-
- [ ] `settings > Actions > General`, Scroll to the bottom of the page, under `Workflow permissions`, check `Read and write permissions`, and click the save button.
31-
32-
- [ ] `settings > Pages`, In `Build and deployment`, select `Deploy from a branch` for `Source`, choose `gh-pages` for `Branch`, and click the save button.
33-
(The `gh-pages` branch may not exist upon first creation. You can complete the above setup first, push the code to the main branch, wait for `github actions` to finish, and then proceed with the setup.)
34-
35-
- [ ] Modify the `base` option in `docs/.vuepress/config.ts`:
36-
- If you are planning to deploy to `https://<USERNAME>.github.io/`, you can skip this step as `base` defaults to `"/"`.
37-
- If you are planning to deploy to `https://<USERNAME>.github.io/<REPO>/`, meaning your repository URL is `https://github.com/<USERNAME>/<REPO>`, set `base` to `"/<REPO>/"`.
38-
39-
To customize a domain name, please refer to [Github Pages](https://docs.github.com/zh/pages/configuring-a-custom-domain-for-your-github-pages-site/about-custom-domains-and-github-pages)
40-
41-
## Documents
42-
43-
- [vuepress](https://vuepress.vuejs.org/)
44-
- [vuepress-theme-plume](https://theme-plume.vuejs.press/)
9+
- [项目介绍](https://python.yxzl.dev/5njxhpwr/)
10+
- [贡献者信息](https://python.yxzl.dev/taqbzfxf/)
11+
- [参考和引用列表](https://python.yxzl.dev/fijhd6jw/)

README.zh-CN.md

Lines changed: 0 additions & 44 deletions
This file was deleted.

docs/0 前言/0.1 前言.md

Lines changed: 27 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,40 @@ permalink: /5njxhpwr/
77

88
## 写作背景
99

10+
::: details 写作背景
1011
本人作为一个信竞菜鸟,平时经常使用 Python 编写实用项目,对 Python 的基础有比较全面的了解。
1112

1213
阅读目前社会上的 Python 入门教程,有的针对青少年和无基础群体,并没能做到通俗易懂,反而损失了大量知识点;有的书写得很专业,但是缺点也是过于专业,没有其他编程语言的基础根本没法看懂。与此同时,现在可找到的资源更多的则是 Python 3.6 版本甚至更早的旧内容,很多内容没有及时更新了。
1314

1415
对于其它网络上的零散资源,的确可以帮你快速掌握 Python——如果你有一门及以上精通的编程语言的话。因为在这样的情况下你学习一门新的编程语言,是通过与你已经掌握的编程语言进行对比来记忆的,只要告诉你大体的内容你就可以做到**先记忆后理解**;但是这样子的学习方法是对新手非常不友好的。菜鸟教程的纯参考手册性质导致其在某些部分出现了完全没有提到过的概念(简单理解就是知识的排序并非循序渐进)。
1516

16-
由此,我萌生了重写一本手册的想法。这本手册主要针对**无代码基础、但有一定电脑使用基础的人群**
17+
由此,我萌生了重写一本手册的想法。
1718

18-
这个项目于 2021 年 9 月开始,但是在实行一周我放弃了——想要写出一个新手友好的文档,无疑需要对任何互联网教程的内容顺序做大量重新排序,工作量极大。2022 年暑假,技术有所长进的我重新拾起,并组建了维护团队,完成了手册的大部分内容。2025 年秋季,我来到上海纽约大学,看到身边许多同学被 Introduction to Computer Programming 折磨,于是将这份文档大幅修订并重新部署。
19+
这个项目于 2021 年 9 月开始,但是在实行一周我放弃了——想要写出一个新手友好的文档,无疑需要对任何互联网教程的内容顺序做大量重新排序,工作量极大。
20+
21+
2022 年暑假,技术有所长进的我重新拾起,并组建了维护团队,完成了手册的大部分内容。
22+
23+
2025 年秋季,我来到上海纽约大学,看到身边许多同学被 Introduction to Computer Programming 折磨,于是将这份文档大幅修订并重新部署。
24+
:::
25+
26+
## 项目特点
27+
28+
1. 这份文档主要针对**无代码基础、但有一定电脑使用基础的人群**
29+
30+
2. 本文档采用了较为激进的编写方式,且在实践中收获了好评:
31+
32+
- 顺序上,我们创新性地先讲解字符串、列表,后讲解循环语句和逻辑运算,意在尽可能减少当前知识点对后续知识点的依赖,使学习体系性更强
33+
- 知识介绍上,我们大胆使用一些简化但与事实不完全相符的叙述,以帮助学习者减小学习难度(例如在讲解“类”的知识前先用“函数”来解释 `int()` 类型转换)。
34+
35+
::: note 关于这一点的进一步解释
36+
- 市面上大多数教学材料在遇到这类问题时,选择的方案是回避,容易让学习者产生更严重的误解。
37+
- 这样的尝试发生在一些细节处。许多熟练使用 Python 者也无法准确回答这些细节。
38+
- 通过对高中学业水平考试、部分大学编程相关课程考试等试题的分析,我们没有找到对相关概念考察的要求。
39+
- 对这些不完备的介绍,我们均通过小字介绍的方式防止对学习者造成误导。
40+
- 截至目前,这样的编排方式收到了使用者(包括读者和使用本文档辅助教学的人)的广泛好评。
41+
:::
42+
43+
3. 本文档大部分代码示例支持在线编辑和运行。
1944

2045
## 原创和版权声明
2146

0 commit comments

Comments
 (0)