Skip to content
This repository has been archived by the owner on Mar 25, 2021. It is now read-only.

Document-Collection/tools-platform-guide

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

66 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

本仓库不再维护,更新的内容前往:ZJDoc/ToolGuide

tools-platform-guide

Documentation Status standard-readme compliant Conventional Commits Commitizen friendly

工具和平台配置

小结开发工具以及开发平台的配置和使用

仓库中还包含了VSCode的代码实例和代码片段(C++/Python,位于vscode目录下)

内容列表

背景

之前在不同平台(Windows/Ubuntu)上尝试过各种不同的编辑工具,比如Sublime、Atom、gedit、Markdown Pad,都有各自的缺陷:不跨平台,编辑繁琐,功能过少等等

VSCode确实极大的提高了文档编辑体验,不过要自定义编辑环境、配置不同语言集成还需要好好学习一番

本仓库最开始用于管理VSCode文档和代码,之后逐渐扩充到多个工具和开发平台的配置

安装

编译文档需要预先安装以下工具:

$ pip install mkdocs

用法

文档有两种使用方式

  1. 在线浏览文档:Tools&Platform Guide

  2. 本地浏览文档,实现如下:

    $ git clone https://github.com/zjZSTU/tools-platform-guide.git
    $ cd tools-platform-guide
    $ mkdocs serve
    

    启动本地服务器后即可登录浏览器localhost:8000

主要维护人员

  • zhujian - Initial work - zjZSTU

参与贡献方式

欢迎任何人的参与!打开issue或提交合并请求。

注意:

许可证

Apache License 2.0 © 2019 zjZSTU