diff --git a/doc/README.txt b/doc/README.txt
new file mode 100644
index 0000000..9e67291
--- /dev/null
+++ b/doc/README.txt
@@ -0,0 +1,2 @@
+* User Guide: https://www.gitbook.io/book/88250/wide-user-guide
+* Developer Guide: https://www.gitbook.io/book/88250/wide-dev-guide
\ No newline at end of file
diff --git a/doc/zh_CN/conf.html b/doc/zh_CN/conf.html
deleted file mode 100644
index 97b969d..0000000
--- a/doc/zh_CN/conf.html
+++ /dev/null
@@ -1,32 +0,0 @@
-
-
-
-
- Wide - 配置
-
-
-
- 配置
-
-
-{
- "Server": "{IP}:7070", 运行的 IP,端口
- "StaticServer": "http://{IP}:7070", 静态资源服务 IP,端口
- "EditorChannel": "ws://{IP}:7070", 编辑器消息通道
- "OutputChannel": "ws://{IP}:7070", 输出窗口消息通道
- "ShellChannel": "ws://{IP}:7070", Shell 消息通道
- "StaticResourceVersion": "201409032040", 静态资源版本
- "MaxProcs": 4, Go 协程并行处理数量,可等于 Go CPU 核数
- "RuntimeMode": "dev", 运行模式,dev 为开发模式,prod 为生产模式
- "Pwd": "{pwd}", 工作目录,设置为 "{pwd}" 将自动获取
- "Users": [
- {
- "Name": "admin", 用户名
- "Password": "admin", 用户密码
- "Workspace": "{pwd}/data/user_workspaces/admin" 用户工作空间(GOPATH)
- }
- ]
-}
-
-
-
diff --git a/doc/zh_CN/dev/index.html b/doc/zh_CN/dev/index.html
deleted file mode 100644
index 3b662b3..0000000
--- a/doc/zh_CN/dev/index.html
+++ /dev/null
@@ -1,79 +0,0 @@
-
-
-
-
- Wide - 开发指南
-
-
-
- 开发指南
-
- 该文档介绍了 Wide 的核心设计原理与实现。
-
-
-
- 如果您要读 Wide 的源码或者要进行修改、二次开发等,请先仔细阅读该文档。
-
-
- 关键设计
- 工作空间
-
- Wide 是一个多用户的集成开发环境,每个用户的工作空间是完全隔离的:
-
-
-
- 例如在执行“构建 & 运行”时,Wide 会设置命令 go build 执行的环境变量 $GOPATH 为用户的工作空间,这样编译过程就是在该用户的工作空间中进行,保证其隔离性。
-
-
- 会话
-
- 在 UI 上存在两种 tab:浏览器 tab;编辑器 tab。
- 用户可以在一个浏览器 tab 中打开多个编辑器 tabs,但输出窗口只有一个。这意味着一个浏览器 tab 只能有一个正在运行的用户代码的程序进程。
- 需要同时运行多个程序进程的场景可以通过打开多个浏览器 tabs 达成。
-
-
-
- - 一个浏览器 tab 对应一个 Wide 会话:只要打开/刷新一个 tab,就会新建一个 Wide 会话
- - Wide 会话的 id 在源码中统一命名为
sid
,在需要使用 HTTP 会话的地方也统一明确表明
-
-
- WebSocket
-
- WebSocket 用于后端推送数据给前端:
-
-
- - 输出通道
- - 通知通道
- - Shell 通道
-
-
- 通道和会话一对一关联,也就是说如果用户新开浏览器 tab,则新建通道和其关联。
-
- 事件与通知
-
- 每个会话都有一个对应的事件队列,当接收到事件时取出该事件并转为通知,再通过通知窗口通道推送给前端。
- 还存在一个全局事件队列,入队的事件将分发到每个用户的事件队列中,以便进行通知广播。
-
-
-
- 通知中的消息需要国际化处理。在语言配置文件中以 notification_ 为前缀,事件代码(event code)为后缀的项即通知消息。
-
-
- 代码辅助
-
-
- - 自动完成,通过 gocode 工具实现
- - 跳转到声明,通过 ide_stub 工具实现
- - 查找使用,通过 ide_stub 工具实现
-
-
- 代码辅助功能满足工作空间隔离。
-
-
- 编码规范
-
-
diff --git a/doc/zh_CN/editor.html b/doc/zh_CN/editor.html
deleted file mode 100644
index 0c11c41..0000000
--- a/doc/zh_CN/editor.html
+++ /dev/null
@@ -1,35 +0,0 @@
-
-
-
-
- Wide -编辑器
-
-
-
- 编辑器
-
- Tabs
-
- -
- 新打开一个文件会新开一个编辑器,最多可以打开 64 个编辑器
-
- -
- 焦点切换到编辑器(Ctrl+0)时,左边的文件树也会选中相关的文件
-
-
- 在多个 tabs 之间切换快捷键:Ctrl+Tab
-
- -
- 关闭当前编辑器快捷键:Ctrl+W
-
-
-
- 文件保存
- 在下面几种情况发生时会保存编辑器内容:
-
- - 保存/格式化:将保存当前编辑器的内容
- - 构建 & 运行/go install:将保存所有打开的编辑器的内容
- - 自动完成/跳转到声明/查找使用:将保存当前编辑器的内容
-
- 我们基本可以认为在写代码时文件是实时自动保存的。
-
-
diff --git a/doc/zh_CN/faq.html b/doc/zh_CN/faq.html
deleted file mode 100644
index 7e78112..0000000
--- a/doc/zh_CN/faq.html
+++ /dev/null
@@ -1,67 +0,0 @@
-
-
-
-
- Wide - 常见问题与解答
-
-
-
- 常见问题与解答
-
-
- - 默认用户是?
-
- 默认用户是 admin 用户。用户名:admin,密码:admin。
-
-
- - 什么是工作空间?
-
- 工作空间是当前用户的 $GOPATH 路径指定的目录,一个用户只能有一个工作空间。
- 例如 admin 用户的工作空间默认路径是 {wide}/data/user_workspaces/admin/,可以在 wide.json 中配置。
-
-
- - wide.json 是什么?
-
- wide.json 是 Wide 的配置文件,路径是 {wide}/conf/wide.json。Wide 的所有配置(例如端口、工作空间、用户帐号、用户选项等)都是保存在这个文件中的。
-
-
-
- 如果 Wide 是个人使用,那么默认的配置应该可以很好的工作,不需要修改任何地方。
-
-
- - 如何才能使用已有 $GOPATH?比如我的 $GOPATH 是 D:\\GoGoGo,我要如何才能使用这个目录作为 admin 用户的工作空间?
-
- 修改 wide.json 中 admin 用户的 Workspace,将其从默认的 "{pwd}/data/user_workspaces/admin" 改为 "D:\\GoGoGo"。
-
-
-
- $GOPATH 是可以通过路径分隔符(Linux 下是 :,Windows 下是 ;)配置多个路径的,但我们不建议您这样配置,因为多个多个目录会造成构建/代码补全等功能的性能下降。
-
-
- - 文件树里的 Go API 目录是什么?
-
- 该目录是读取 $GOROOT/src/pkg 生成的,方便用户查看 Go API 源代码。
- 在该目录下是不允许新建、编辑、删除文件的。
-
-
- - 如何配置多用户?
-
- 修改 wide.json 中的 Users 数组,按照默认用户的格式(用户名、密码等)添加。
-
-
- - 为什么代码辅助功能(自动完成/跳转到声明等)失效了?
-
- 请确认正确安装了 gocode 和 ide_stub 工具。安装命令:
-
-
-
- - go get -u github.com/88250/ide_stub
- - go get -u github.com/nsf/gocode
-
-
-
- 如果安装不对,Wide 会自动检查并通过通知窗口告知用户。另外,通知窗口还会告知用户一些其他重要信息,例如 IDE 版本更新提醒等。
-
-
-
-
diff --git a/doc/zh_CN/features.html b/doc/zh_CN/features.html
deleted file mode 100644
index 24091af..0000000
--- a/doc/zh_CN/features.html
+++ /dev/null
@@ -1,26 +0,0 @@
-
-
-
-
- Wide -特性列表
-
-
-
- 特性列表
-
-
- - 代码高亮、折叠:Go/HTML/JavaScript/Markdown 等
- - 自动完成:Go/HTML 等
- - 编译检查:编辑器提示编译错误
- - 格式化:Go/HTML/JSON 等
- - 运行:支持同时运行多个程序,方便联调
- - 调试:基于 gdb 的调试系统
- - 多用户:团队开发,方便协作
- - 代码导航:跳转到声明,查找使用,文件搜索等
- - Shell:连接到服务器执行命令
- - Web 开发:前端(HTML/JS/CSS)开发支持
- - go tool:go get/install/fmt 等
- - Git 整合:常用 git 命令可视化操作
-
-
-
diff --git a/doc/zh_CN/index.html b/doc/zh_CN/index.html
deleted file mode 100644
index aec72cb..0000000
--- a/doc/zh_CN/index.html
+++ /dev/null
@@ -1,41 +0,0 @@
-
-
-
-
- Wide - 文档首页
-
-
-
- Wide
-
- Wide 是一个基于 Web 的团队 Golang IDE。
-
-
-
-
- 特性
-
- - 语法高亮
- - 自动完成提示
- - 代码格式化
- - 运行 & 调试
- - 多用户
- - 文件导航与跳转
- - Shell
- - Git 集成
- - Web 开发支持
-
- 完整特性列表。
-
- 使用指南
-
-
-
-
-
-
diff --git a/doc/zh_CN/keyboard_shortcuts.html b/doc/zh_CN/keyboard_shortcuts.html
deleted file mode 100644
index cb5d4d1..0000000
--- a/doc/zh_CN/keyboard_shortcuts.html
+++ /dev/null
@@ -1,47 +0,0 @@
-
-
-
-
- Wide - 键盘快捷键
-
-
-
- 键盘快捷键
-
- 编辑器
-
- - Ctrl+\: 自动补全
- - Ctrl+B:跳转到声明
- - Alt+Shift+F:格式化
- - Ctrl+G: 跳转到行
- - Ctrl+E: 删除当前行
- - Ctrl+S:保存当前编辑器文件
- - F11: 编辑器全屏
-
- - Shift+Tab: 自动缩进
- - Ctrl+]: 缩进
- - Ctrl+[: 反缩进
-
-
- 焦点
-
- - Ctrl+0:焦点切换到编辑器
- - Ctrl+1:焦点切换到文件树
- - Ctrl+4:焦点切换到输出窗口
- - Ctrl+5:焦点切换到搜索窗口
- - Ctrl+6:焦点切换到通知窗口
- - Ctrl+Tab:编辑器 Tabs 切换
- - Ctrl+W:关闭当前编辑器
-
-
- 运行
-
-
- TBD:
-
-
-
diff --git a/doc/zh_CN/motivation.html b/doc/zh_CN/motivation.html
deleted file mode 100644
index 399a38d..0000000
--- a/doc/zh_CN/motivation.html
+++ /dev/null
@@ -1,40 +0,0 @@
-
-
-
-
- Wide - 动机
-
-
-
- Wide 的由来
-
-
- - 团队的 IDE:
-
- - 安全可靠:项目源代码实时保存在服务器上,开发者的机器崩溃不会丢失任何源代码
- - 统一环境:服务器统一配置开发环境,开发者本机无需任何额外配置
- - 开箱即用:5 分钟搭建服务器;开发者打开浏览器即可开发、调试
- - 版本控制:每个开发者拥有自己的源代码仓库,随时可和主干保持同步
-
-
- - 基于 Web 的 IDE:
-
- - 客户端只需要浏览器
- - 跨平台,甚至在移动设备上
- - For the geeks
-
-
- - 商业-开源的一次尝试:会推出专门为企业定制的 Wide,贴近开发流程
- - 目前较为流行的 Go IDE 都有一些缺陷或遗憾:
-
- - 文本编辑器类(vim/emacs/sublime/Atom 等):对于新手门槛太高,搭建复杂
- - 插件类(goclipse 等):需要原 IDE 支持,不够专业
- - LiteIDE:界面不够 modern :p
- - 没有团队开发体验
-
-
- - Go IDE 很少,用 Go 本身开发的 IDE 更是没有,这是一个很好的尝试
-
-
-
-
diff --git a/doc/zh_CN/multiplayer.html b/doc/zh_CN/multiplayer.html
deleted file mode 100644
index a0a3ad1..0000000
--- a/doc/zh_CN/multiplayer.html
+++ /dev/null
@@ -1,25 +0,0 @@
-
-
-
-
- Wide - 多用户
-
-
-
- 多用户
-
- 支持多个用户同时使用一个 Wide 服务器,每个用户有自己独立的源代码仓库,编码/运行/调式都是在自己的工作空间中进行,不会影响其他用户。
-
-
- 工作空间
-
- Wide 的工作空间就是 Go 中的 workspaces,每个用户的工作空间路径可在 wide.json 中进行配置。
-
-
- 运行时
-
- 用户在运行程序时进程是跑在服务器上的,所以多用户同时运行程序时最常见的问题就是资源冲突(比如网络端口),目前这个问题只能靠用户自行规避。
-
-
-
-
diff --git a/doc/zh_CN/setup.html b/doc/zh_CN/setup.html
deleted file mode 100644
index c91dd8d..0000000
--- a/doc/zh_CN/setup.html
+++ /dev/null
@@ -1,47 +0,0 @@
-
-
-
-
- Wide - 安装
-
-
-
- 安装
-
- 基础安装
-
- - 下载 Wide 安装包
- - 解压到安装路径 {wide},例如 /root/wide
- - 配置 {wide}/conf/wide.json(可选,默认配置应该可以工作)
-
-
- 多用户配置
- 前提:需要安装 git。
-
- - 初始化主库:在 {wide}/data/workspace/src 下执行 git init
- - 添加用户:修改 {wide}/conf/wide.json 中的 Users
- - 添加用户库:在 {wide}/data/user_workspaces/{user}/ 中 git clone 主库
-
-
- 从源码安装
- 前提:
-
- - 搭建好 Go 开发环境
- - 安装好 git
-
-
- 步骤:
-
- - 通过
git clone
或下载 zip 包方式获取 Wide 源码(项目地址:https://github.com/b3log/wide)
- - 获取依赖,在 Wide 源码目录下执行:
-
- go get -u
- go get -u github.com/88250/ide_stub
- go get -u github.com/nsf/gocode
-
- - 编译:在 Wide 源码目录下执行
go build
- - 配置 {wide}/conf/wide.json(可选,默认配置应该可以工作)
- - 运行可执行文件 wide 或 wide.exe
-
-
-