本仓库不再维护,更新的内容前往:ZJDoc/ToolGuide
工具和平台配置
小结开发工具以及开发平台的配置和使用
仓库中还包含了VSCode
的代码实例和代码片段(C++/Python
,位于vscode
目录下)
之前在不同平台(Windows/Ubuntu
)上尝试过各种不同的编辑工具,比如Sublime、Atom、gedit、Markdown Pad
,都有各自的缺陷:不跨平台,编辑繁琐,功能过少等等
VSCode确实极大的提高了文档编辑体验,不过要自定义编辑环境、配置不同语言集成还需要好好学习一番
本仓库最开始用于管理VSCode
文档和代码,之后逐渐扩充到多个工具和开发平台的配置
编译文档需要预先安装以下工具:
$ pip install mkdocs
文档有两种使用方式
-
在线浏览文档:Tools&Platform Guide
-
本地浏览文档,实现如下:
$ git clone https://github.com/zjZSTU/tools-platform-guide.git $ cd tools-platform-guide $ mkdocs serve
启动本地服务器后即可登录浏览器
localhost:8000
- zhujian - Initial work - zjZSTU
欢迎任何人的参与!打开issue或提交合并请求。
注意:
GIT
提交,请遵守Conventional Commits规范- 语义版本化,请遵守Semantic Versioning 2.0.0规范
README
编写,请遵守standard-readme规范
Apache License 2.0 © 2019 zjZSTU