ShadowEditor/UserGuide.md

使用指南

该项目仅支持Windows系统，电脑上需要安装.Net Framework 4.5。

推荐使用最新版谷歌浏览器查看示例，不保证兼容其他浏览器。

1. 安装NodeJs，在当前目录，执行以下命令。

npm install
npm run build

2. 下载MongoDB，安装并启动MongoDB服务。MongoDB服务的默认端口为27017。

mongod --dbpath=D:\mongodb\db --logpath=D:\mongodb\log\mongoDB.log --install --serviceName MongoDB
net start MongoDB

3. 编辑文件ShadowEditor.Web/Web.config，将27017修改为你电脑上MongoDB服务的端口。

<add key="mongo_connection" value="mongodb://127.0.0.1:27017" />

4. 使用Visual Studio 2017打开项目，生成ShadowEditor.Web项目。

5. 将ShadowEditor.Web部署在iis上即可在浏览器中访问。

6. 为了保存各种类型文件能正常下载，需要在iis上添加以下两个MIME类型。

文件扩展名	MIME类型	说明
.*	application/octet-stream	各种格式后缀文件
.	application/octet-stream	无后缀文件

7. 编译文档，请安装gitbook。

npm install -g gitbook-cli

然后切换到docs-dev目录，安装gitbook插件。

gitbook install

然后切换到上级目录，执行以下命令生成文档。

npm run build-docs