# 环境准备

在参与开源电子书项目之前,你需要准备以下环境:

  • GitHub账号
  • Git
  • Node.js
  • Markdown编辑器

# 注册GitHub账号

首先,打开GitHub官网 (opens new window),如果官网打开缓慢或者无法打开,可以使用DevSidecar-mac (opens new window), DevSidecar-win (opens new window)进行加速,点击Sign Up,填写以下信息

github reg

点击Create account完成账号注册。完成注册后,你填写的邮箱会收到一封确认的邮件,点击Verify email address

github verify

完成确认后,你的GitHub账号就注册成功啦。

# 配置Git

前往Git官网 (opens new window),根据操作系统自行选择对应的版本进行安装,这边以 Windows 为例,Mac安装请参考Mac build git (opens new window)

下载 (opens new window)Git安装包,双击打开,按照指引,下一步完成安装即可。打开命令行,输入git --version,如出现对应的版本号,则表示安装成功。

git version

接下来我们需要创建一个全局用户名和全局邮箱作为配置信息,

$ git config --global user.name "your_name"
$ git config --global user.email "your_email@youremail.com"

这里的your_name以及your_email@youremail.com为方便统计贡献信息请尽量与你GitHub里的信息保持一致。

# 安装Node.js

打开Node.js官网 (opens new window),根据操作系统自行选择对应的版本进行安装,这边以 Windows 为例,Mac安装请下载对应的Mac安装包。

下载 (opens new window)Node安装包,这里我们选择LTS版本,这个是Node发行的稳定版本,双击打开,按照指引,下一步完成安装即可,打开命令行,输入node -v & npm -v,出现对应的版本号,则表示安装成功。

node version

npm默认的镜像源为国外镜像源,下载可能会出现缓慢或卡死的情况,建议采用一下方式进行处理。

  1. 安装cnpm,配置淘宝镜像源;
$ npm install -g cnpm --registry=https://registry.npmmirror.com
  1. 使用DevSidecar打开npm加速。

# Markdown编辑器

由于项目中图文内容基于Markdown语法进行创作,我们需要一款优秀的Markdown编辑器,这里我们推荐Typora (opens new window),干净、简洁、语法支持丰富,让你专注创作,打开官网,下载对应的安装包,安装即可。

当然,同学们可以根据自己的喜好使用自己平时常用的编辑器进行创作,如果有同学还不熟悉Markdown语法,可以参考Markdown语法整理 (opens new window)

至此,基础环境已经准备完成,接下来将教同学们如何配置项目,提交PR(Pull Request)。