[toc=2] # 看云的[使用文档](http://help.kancloud.cn/41497) # 看云的主要功能介绍 ## 创建文档  #### 文档类型: * **普通文档**：默认类型，不带任何初始插件，可用于一般书籍和笔记； * **技术文档**：默认加载代码高亮插件，可以用于技术文档和技术书籍； * **API文档**：用于API文档的快速生成，支持在线调试； * **单页文档**：用于只需要一个页面的文档（没有目录结构）； * **导入文档**：导入已有的CHM/EPUB/Word格式的文档； * **GIT文档**：从你的GIT版本库地址导入文档 #### 文档标识: >[danger] 实际上就是Git项目名 #### 文档标识命名规范: * 只能包含小写字母和数字，以及“-”和“_”符号，并且以小写字母打头，长度不超过30个字符 * 文档标识用于版本库以及URL地址访问，一旦确定就不能更改。 #### 文档的公开和私有: * 公开: 任何人都可以访问, 也可以通过看云搜索到 * 私有: 只有邀请或者通过令牌才能访问, 看云搜索不到, 只有专业版和企业版用户才能创建私有文档 * `可以在创建文档后进行公开和私有文档的切换` #### 描述信息: * 用于文档的简要描述，会在阅读入口页面显示。 * 不用担心写错，除了文档标识之外，其他文档资料都可以在以后重新设置。 ## 文档管理  >[info] 每个文档都有一个独立的GIT版本库地址，并且每个文档可以使用50M的版本库空间，如果超过的话可以单独付费扩容 * **文档概要**：文档的概要入口，包括基本信息和常用操作。 * **`发布管理`**：进行文档的发布操作和历史查看。 * **文档成员**：管理文档的成员，可以用于协作。 * **绑定域名**：把某个域名绑定到当前文档（私有文档和付费文档不支持绑定域名）。 * **文档定价**：给当前文档定价，并且设置试读章节。 * **`文档设置`**：文档的一些基本信息的设置和管理。如果需要删除文档也在这里进行。 ## 封面图片 >[danger] 给你的文档设置一个封面图片（尤其是公开文档）是一个良好的习惯，官方推荐文档会优先推荐带有封面图片的文档。 #### 系统默认的封面, 长这个样子...  #### 封面设置   * 封面图片的规范是 865*1155或者等比例的图片. 如果比例不对, 预览时图片会变形, 实际生效后, 超出部分会被裁掉 * 如果你是在文档发布之后更换的封面图片的话，记得必须要重新发布后才能生效，而且会受CDN的影响而有所延迟（必要的时候还需要清空你的浏览器缓存）。 ## 编辑内容 #### 文档编辑的两个操作入口   #### 进入编辑模式后，默认打开一个包含一个目录的空白文档。  #### 看云采用的是MarkDown格式的排版，左边是编辑区，右侧则是同步预览效果区。  #### 文档发布 * 完成当前内容编辑后会自动保存，但只有点击右上角的同步按钮,才会同步修改的内容到版本库（当前没有内容需要同步到服务器的时候按钮呈灰色） * 编辑模式下的任何更改必须遵循`编辑`==>`同步`==>`发布`后，才能更新在线阅读版本。 #### 文档历史 * 点击发布按钮右侧的 按钮就可以查看当前内容的编辑历史记录  * 历史记录窗口左侧会显示当前内容的编辑历史记录，点击即可在右侧查看差异内容。 #### 全文预览 * 如果你需要和阅读环境一样预览当前文档的编辑内容，可以使用右上角的全文预览按钮 。 #### 系统帮助 * 右侧的帮助按钮可以快速进入看云的帮助手册。  #### 文档相关设置 * 文档编辑页面右上角有一个下拉菜单，这里可以进行一些文档相关的设置。  #### 文档概要 * 可以在文档概要里面添加文档的详细描述信息，会显示在阅读页面的概要中（一样使用md编码格式）  ## 目录操作 #### 新增目录 * 编辑模式下面，最左侧的区域就是目录显示和操作区，可以点击新建章节按钮添加一级目录  * 对应文件会自动生成，也可以自己编辑输入。 * 在目录文件中每个目录都对应一个md文件，该文件的命名可以使用中文，但不能使用下列特殊字符：`\/:*<>|"`。 * 注意不要删除对应文件的后缀标识，如果文件名中使用`/`会作为目录处理。 #### 创建子目录/编辑/删除目录 * 如果要创建子目录，可以选中某个目录后点击鼠标右键，在弹出菜单中选择新建章节即可创建子目录，支持创建多级子目录。 * 同样，如果需要对某个目录进行编辑和删除操作的话，也都使用右键操作即可。  #### 目录排序 * 直接用鼠标拖动某个目录就可以对目录进行排序操作，支持跨级拖动排序。 * 当出现绿色勾标志的时候表示该位置可以拖动，如果出现红色叉表示当前位置不能拖动。  #### 目录设置 * 如果需要对目录进行批量编辑或者排序，可以点击右上角下拉菜单选择目录设置  * 就可以在编辑区进行目录的高级编辑，不过需要注意如下几点： * 目录对应的文件不要随便更改，容易导致之前的内容丢失； * 目录之间不得存在空行，会导致目录解析为空； * 目录文件中不要包含列表数据之外的内容； ## 文档设置  * 默认情况下，文档的评论功能是关闭的，可以开启文档的评论功能。 * 如果不希望提供文档的下载功能（默认开启），也可以在设置页面关闭文档下载功能。 * 如果希望接受读者的打赏，可以开启打赏功能。  * 可以把文档从公有文档切换到私有文档，点击转为私有按钮即可。 * 在转为私有文档的时候请确保你有足够的可用私有文档数量。  * 如果你需要把自己的文档转让给其他人，则可以点击转让文档按钮进行操作，系统会让你确认文档标识，以及被转让的用户或者团队标识。  * 如果你需要删除当前的文档，可以点击删除文档按钮永久删除（不可恢复）。 * 删除之前也需要确认删除的文档标识，以免误删  ## 发布文档 >[info] 看云的编辑版本和发布版本是独立的，编辑版本的改动不会影响线上的发布版本，只有进行文档的发布操作后才会将当前的编辑版本同步更新到线上阅读。 > 文档如果是刚创建的，那么在没有发布之前，是不能在线阅读的。 #### 手动发布  * 每次发布之前，会显示上次发布以来的差异。 * 点击发布按钮进行文档发布操作。  * 如果你的文档内容（尤其是图片）较多的话，发布操作可能需要一点时间。 * 如果发布按钮不能点击，表示当前没有文档更新，无需发布。 * 如果出现绿色标记表示发布完成，如果出现红色标记，可能发布失败了可以再次重新发布。发布完成后，就可以在文档概要页面右上角看到阅读和下载按钮了。  你可以下载文档的PDF/EPUB/MOBI/HTML格式版本。 #### 自动发布  ## 插件扩展 #### 使用插件 >[info] 看云在核心功能之外，提供了很多的插件扩展用于一些高级功能 ##### 文档设置中进行插件设置 首先，在文档的编辑模式下点击最右侧的下拉列表，打开文档配置。   然后，在弹出的文档设置内容框里面输入相关设置参数后点击左上角的保存按钮  最后一步（千万不要忘了），重新发布下当前文档，修改的配置参数才会生效。  #### 在文件中进行插件配置 >[info] 如果你使用了离线写作和远程提交的话，也可以直接在版本库根目录中编辑book.json文件（如果不存在则需要自行创建）进行插件参数设置。   ##### 单个插件 ```json { "plugins":["highlight"], } ``` ##### 多个插件 ```json { "plugins":["highlight","api"], } ```