diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..5c3a1a2 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +# MacOS +.DS_Store + +# for docs +docs/index.md +site/ + +# for vscode +.vscode/ diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..42273f3 --- /dev/null +++ b/Makefile @@ -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 diff --git a/README.md b/README.md index 29edc93..8d38b00 100644 --- a/README.md +++ b/README.md @@ -4,7 +4,6 @@ Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的介绍,如果有更详细的中文介绍,对相应开发者的帮助会更大。这也是我们发起这个开源项目的初衷。 -* * * ### 我们要做什么? @@ -13,20 +12,6 @@ Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的 - 《[Scrapy:Python 的爬虫框架](http://hao.jobbole.com/python-scrapy/)》 - 《[Flask:一个使用 Python 编写的轻量级 Web 应用框架](http://hao.jobbole.com/flask/)》 -* * * - -### 如何参与本项目? - - - -* * * ### 如何为列表贡献新资源? @@ -39,7 +24,6 @@ Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的 感谢您的贡献! -* * * ### 本项目的参与者 @@ -48,17 +32,6 @@ Awesome 系列虽然挺全,但基本只对收录的资源做了极为简要的 注:名单不分排名,不定期补充更新 -* * * - - ### 环境管理 diff --git a/docs/.gitkeep b/docs/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/mkdocs.yml b/mkdocs.yml new file mode 100644 index 0000000..ea41a23 --- /dev/null +++ b/mkdocs.yml @@ -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"