Skip to content

Commit 4a30781

Browse files
committed
Update: 删减 readme 注释片段,新增其他项目文件,用于生成文档
1 parent 0c7251b commit 4a30781

File tree

5 files changed

+37
-27
lines changed

5 files changed

+37
-27
lines changed

.gitignore

+9
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
# MacOS
2+
.DS_Store
3+
4+
# for docs
5+
docs/index.md
6+
site/
7+
8+
# for vscode
9+
.vscode/

Makefile

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
site_install:
2+
pip install mkdocs==0.16.3
3+
pip install mkdocs-material==1.12.2
4+
5+
site_link:
6+
ln -sf $(CURDIR)/README.md $(CURDIR)/docs/index.md
7+
8+
site_preview: site_link
9+
mkdocs serve
10+
11+
site_deploy: site_link
12+
mkdocs gh-deploy --clean

README.md

-27
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44

55
Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的介绍,如果有更详细的中文介绍,对相应开发者的帮助会更大。这也是我们发起这个开源项目的初衷。
66

7-
* * *
87

98
### 我们要做什么?
109

@@ -13,20 +12,6 @@ Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的
1312
-[Scrapy:Python 的爬虫框架](http://hao.jobbole.com/python-scrapy/)
1413
-[Flask:一个使用 Python 编写的轻量级 Web 应用框架](http://hao.jobbole.com/flask/)
1514

16-
* * *
17-
18-
### 如何参与本项目?
19-
20-
<!-- 从下面的目录来看,本项目的工作量小不了,所以非常期待能有更多程序员一起来参与。
21-
22-
不过加入前,有几个小要求:
23-
24-
* 英文还不错,能读懂英文并用自己的话复述;
25-
* 在用 Python;
26-
27-
如有兴趣,请加 QQ:50872495。加 Q 时请注明「Python大全」 -->
28-
29-
* * *
3015

3116
### 如何为列表贡献新资源?
3217

@@ -39,7 +24,6 @@ Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的
3924

4025
感谢您的贡献!
4126

42-
* * *
4327

4428
### 本项目的参与者
4529

@@ -48,17 +32,6 @@ Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的
4832

4933
注:名单不分排名,不定期补充更新
5034

51-
* * *
52-
53-
<!-- ### 奖励计划
54-
55-
虽然奖励可能并不是你加入的主要原因,但还是有必要提一下:
56-
57-
* 整理超过 20 个资源后,可在伯乐在线上开通打赏;
58-
* 每整理 20 个资源,有机会获得技术书籍或各种有意思的创意、极客产品;
59-
* [奖励详情](http://hao.jobbole.com/rewards/)
60-
61-
* * * -->
6235

6336
### 环境管理
6437

docs/.gitkeep

Whitespace-only changes.

mkdocs.yml

+16
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
site_name: 'Python 资源大全中文版'
2+
site_url: 'https://github.com/jobbole/awesome-python-cn/'
3+
site_author: 'jobbole'
4+
repo_name: 'jobbole/awesome-python-cn/'
5+
repo_url: 'https://github.com/jobbole/awesome-python-cn/'
6+
theme: 'material'
7+
extra:
8+
feature:
9+
tabs: false
10+
primary: 'blue'
11+
accent: 'blue'
12+
social:
13+
- type: 'github'
14+
link: 'https://github.com/jobbole/awesome-python-cn/'
15+
pages:
16+
- "人生苦短,我用 Python": "index.md"

0 commit comments

Comments
 (0)