[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"], } ```