# kc-cli 幫助文檔 [TOC] ## 當前版本 * v1.0.0 ## 安裝 > 開始安裝之前，請先確定已經安裝 node.js . 還有 pandoc(可不裝) —— 如果需要文件轉換功能的話。 kc-cli 已經發布到 npm ,直接通過 npm 全局安裝來安裝： npm install -g kc-cli 在部分系統上，你可能需要加上權限聲明，例如在 Ubuntu 上： sudo npm install -g kc-cli 設計的初衷是一個 CLI 工具，所以 kc-cli 沒有 API 可用，不推薦以 node 模塊的方式引入到npm 項目中。當然，這不是說絕對不行，以導入文件的方式還是可以拿到 API 的。 ## 使用 kc-cli 是輔助大家編輯看云文檔的工具，請先從看云把文檔倉庫克隆到本地。然后進入到文件夾打開終端運行 kc-cli 的相應命令來做操作。 > ps: 一定是看云的文檔才行嗎？ 不是的，它可以運行在任何文件夾，只是看云文檔必須先創建才能編輯，而且創建完成之后它并不是一個空的 Git 倉庫。如果你熟悉 Git.你完全在本地弄好一切，最后把看云文檔倉庫作為遠程倉庫， push 到看云就可以了。 **小提示**： 如果你的編輯器集成了終端功能，那么你可以省去不少麻煩。推薦：Visual Studio Code。 ### 命令及說明  命令|說明 ----|---- `kc -h` | 獲取幫助信息。 `kc -v` | 獲取當前版本。 `kc init`| 初始化看云文檔。 `kc theme [cssFilePath] | none`| ——更改文檔CSS樣式(原有樣式會被覆蓋)，請提供CSS文件路徑。例：<br> kc theme d:/mycss/kanyun.css。<br>1. 如果是` kc theme none `則會刪除樣式配置文件（文檔會使用看云默認樣式）。<br>2. 不想要當前樣式的時候可以通過`kc theme none`命令清除樣式。<br>3. 如果只是微調樣式，可以打開website.css文件進行編輯、保存并提交。 `kc summary [dir...]`| 把項目文件夾下的Markdown文件添加到目錄文件 `SUMMARY.md` ,輸出的文件為:'_summary.md' 。<br>[dir...] 是通配符格式路徑，格式和gulp.src([...])一致，只是你不能用[]進行描述，只能像這樣：<br>`kc summary 'a/**/*.md' 'b/*.md' '!README.md'`<br> 如果省略則是當前目錄下全部的.md文件。 `kc md` | 批量創建 `SUMMARY.md` 中列出的 Markdown 文件。 `kc watch [ignore...]`| 監視任務，當文件發生改變的時候自動執行相應的操作。結果：'kc summary' 和 'kc md'。<br>[ignore...] 排除不監視的文件或文件夾。 `kc docx [name]`| 根據 `SUMMARY.md` 中列出的文件創建 .docx 文件，<br>All in one !,所有文檔都在一個.docx文件里。<br>[name] 可以指定輸出的文件名，省略則為：out.docx `kc docx -s` | 根據 `SUMMARY.md` 中列出的文件創建 .docx 文件，一一轉換，每個`.md` 有對應的 `.docx` 文件。 `kc html` | 根據 `SUMMARY.md` 中列出的文件創建 .html 文件，是完整的 HTML 文件 。每個`.md` 和 HTML 文件一一對應。 `kc html code` | 根據 `SUMMARY.md` 中列出的文件創建 .html 文件，只是 HTML 片段。每個`.md` 和 HTML 文件一一對應。 #### 命令補充說明 `kc init` 命令，涉及的文件包括：`style/website.css`、`book.json`、`.gitignore`、封面、`README.md`等。 如果這些文件不存在或者不完整，kc-cli 會創建它們，如果這些文件已經存在 kc-cli 會忽略它們不做任何操作。如果你想使用 kc-cli 提供的默認配置，那么你可以刪除對應的文件，然后運行 `kc init` 來生成這些文件。這一點得做一個詳細的說明： * `README.md` 對應看云文檔的【文檔概要】功能； kc-cli 只是創建它，并不會寫入多余的內容，如果你已經寫好了【文檔概要】功能，千萬不要刪了`README.md`，刪了就沒了，即便有可能從歷史版本中找到，但又何必自找麻煩。 * 封面圖片，沒有封面圖片的話，kc-cli 會有提醒。 * `style/website.css` 看云文檔的自定義樣式文件。沒有的話 kc-cli 會創建并使用看云用戶@xiak 提供的配置方案。如果你已經配置過了，那么 kc-cli 會忽略它。如果你不想要自己的方案，想改成 kc-cli 的方案，可以刪掉這個文件，然后運行 `kc init` 來得到 kc-cli 提供的CSS配置方案。相應的你也可以對 kc-cli 提供的CSS 方案進行微調、刪除，`kc init`命令并不會重復地去更改它。如果你什么樣式都不要，那么請把`style/website.css` 文件的代碼清空然后保存，不要刪，刪的話下次運行`kc init`命令的時候還是被創建。 `kc watch` 命令，它是一個監視器任務，當監視的文件發生變化的時候就會執行指定的任務。在這里 kc-cli 監視除`['!node_modules/**', '!./SUMMARY.md','!./_summary.md', '!./README.md']` 以外的所有 `.md` 文件。執行的任務是：`'kc summary' ` 和 `'kc md'`，當運行這個命令之后，終端會被占用，并且已處于運行狀態，如果你想停止監視或者結束任務，可以在激活（點擊選中）終端之后按 Ctrl+C 中斷進程，輸入“y” 結束進程。 **kc-cli 依賴終端進行工作，關閉終端會導致進程結束。如果命令沒有執行完畢最好不要關閉終端。**