Update: 删减 readme 注释片段,新增其他项目文件,用于生成文档

pull/51/head
chenjiandongx 2018-05-28 16:05:57 +08:00
parent 0c7251b3d4
commit 4a30781e96
5 changed files with 37 additions and 27 deletions

9
.gitignore vendored Normal file
View File

@ -0,0 +1,9 @@
# MacOS
.DS_Store
# for docs
docs/index.md
site/
# for vscode
.vscode/

12
Makefile Normal file
View File

@ -0,0 +1,12 @@
site_install:
pip install mkdocs==0.16.3
pip install mkdocs-material==1.12.2
site_link:
ln -sf $(CURDIR)/README.md $(CURDIR)/docs/index.md
site_preview: site_link
mkdocs serve
site_deploy: site_link
mkdocs gh-deploy --clean

View File

@ -4,7 +4,6 @@
Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的介绍,如果有更详细的中文介绍,对相应开发者的帮助会更大。这也是我们发起这个开源项目的初衷。
* * *
### 我们要做什么?
@ -13,20 +12,6 @@ Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的
- 《[ScrapyPython 的爬虫框架](http://hao.jobbole.com/python-scrapy/)》
- 《[Flask一个使用 Python 编写的轻量级 Web 应用框架](http://hao.jobbole.com/flask/)》
* * *
### 如何参与本项目?
<!-- 从下面的目录来看,本项目的工作量小不了,所以非常期待能有更多程序员一起来参与。
不过加入前,有几个小要求:
* 英文还不错,能读懂英文并用自己的话复述;
* 在用 Python
如有兴趣,请加 QQ50872495。加 Q 时请注明「Python大全」 -->
* * *
### 如何为列表贡献新资源?
@ -39,7 +24,6 @@ Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的
感谢您的贡献!
* * *
### 本项目的参与者
@ -48,17 +32,6 @@ Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的
注:名单不分排名,不定期补充更新
* * *
<!-- ### 奖励计划
虽然奖励可能并不是你加入的主要原因,但还是有必要提一下:
* 整理超过 20 个资源后,可在伯乐在线上开通打赏;
* 每整理 20 个资源,有机会获得技术书籍或各种有意思的创意、极客产品;
* [奖励详情](http://hao.jobbole.com/rewards/)
* * * -->
### 环境管理

0
docs/.gitkeep Normal file
View File

16
mkdocs.yml Normal file
View File

@ -0,0 +1,16 @@
site_name: 'Python 资源大全中文版'
site_url: 'https://github.com/jobbole/awesome-python-cn/'
site_author: 'jobbole'
repo_name: 'jobbole/awesome-python-cn/'
repo_url: 'https://github.com/jobbole/awesome-python-cn/'
theme: 'material'
extra:
feature:
tabs: false
primary: 'blue'
accent: 'blue'
social:
- type: 'github'
link: 'https://github.com/jobbole/awesome-python-cn/'
pages:
- "人生苦短,我用 Python": "index.md"