最簡單的Markdown文檔生成工具 book-cli

時間 2019-11-16

標籤最簡單 markdown 文檔生成工具 book cli 欄目 Markdown 简体版

原文原文鏈接

目前的文檔編寫工具，我想大概推薦：javascript

gitbook
vuepress
ydoc

其餘的我都不太清楚了，還有一些國內文檔編寫的網站，各類選擇。html

是的，造輪子的人又來了。vue

當下的問題：java

gitbook

我就不說了，代碼老舊，控件庫質量層次不齊，我改了一天，勉強能看，再弄弄，竟然有bug，果斷放棄。git

還有上傳同步那一套，搞得我摸不清頭腦....es6

vuepress

尤大的團隊，仍是很值得信任的，功能我看了，是夢想中的功能。github

當時寫一半的時候看到vuepress，當時有考慮過直接用vuepress。bash

只是吧，文檔竟然能有那麼長，而後又是安裝，又是部署，想一想應該沒有多少人訪問的網站，我仍是本身寫個吧。服務器

ydoc

我以爲ydoc仍是很不錯的，就是我在一開始寫文檔的時候，一直想不起名字，致使，我一直沒有找到它。markdown

可是，我剛剛試用了一下，仍是不少細節有欠缺，感受本身改起來應該比較麻煩。

好比說，返回頂部，或者段落標題hash，和vuepress相比的話，缺少不少細節。

很少說了，總之，本身寫的用起來比較爽，好改。

Book-Cli

book-cli 是一個簡單的靜態頁面，用於快速生成說明文檔網站。

簡單來講，book-cli 不須要編譯，你能夠經過直接編寫 Markdown 文件，達到文檔網站的構建。

它是如何工做的？

其實，book-cli 是經過marked, prism等控件，直接使用 javascript 讀取 Markdown 文件，解析文件，再渲染頁面。

因此，不須要編譯，自動化部署簡單（提交代碼便可），入門難度極低。

初始化項目

咱們提供如下三種方案初始化項目：

下載代碼

建議從 book-cli 的 github 中下載代碼至本地。

Fork

在github中直接fork項目。

項目拷貝

使用git拷貝項目，如下爲示例代碼：

git clone https://github.com/vvpvvp/book-cli.git my-project
  git remote set-url origin my-project-github-address
  git push
複製代碼

固然，你也能夠經過其餘方式初始化項目，簡單的來講，就是代碼拷貝。

配置

根目錄下 config.js 文件

var CONFIG = {
  // 網頁 title
  title: 'Book-Cli',
  // 網頁 keywords
  keywords: 'book, book-cli, doc, example',
  // 網頁 description
  description: 'Init html book with markdown files.',
  // 頁面右上角的 github 連接
  github: 'https://github.com/vvpvvp/book-cli',
  // 左側目錄的md文件
  summaryMd: 'SUMMARY.md',
  // 網頁默認訪問的md文件
  index: 'README.md'
}
複製代碼