簡介
一個神奇的文檔網站生成器。
簡單而輕便（〜18kB壓縮）
沒有靜態構建的HTML文件
多個主題
快速開始
建議docsify-cli全局安裝，這有助於本地初始化和預覽網站。
npm i docsify-cli -g
初始化
如果在根目錄中編寫文檔
docsify init ./
寫作內容
在之后init完成后，你可以看到在文件列表./根目錄。
- index.html 作為入口文件
- README.md 作為主頁
- .nojekyll 防止GitHub頁面忽略以下划線開頭的文件
您可以輕松更新文檔./README.md，當然您可以添加更多頁面。
側邊欄
為了有側邊欄，那么你可以創建你自己的_sidebar.md：
首先，你需要設置loadSidebar為true。詳細信息可在配置段落中找到。
<!-- index.html -->
<script>
window.$docsify = {
loadSidebar: true
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
創建_sidebar.md：
<!-- docs/_sidebar.md -->
- [Home](/)
- [Guide](guide.md)
其他詳細配置情參考官方文檔
配置index.html
下面是我參考官方文檔修改的一個配置:
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>Document</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
</head>
<body>
<div id="app">Please wait...</div>
<script>
window.$docsify = {
auto2top: true, //當路線改變時，滾動到屏幕的頂部。
coverpage: true, //激活封面功能。如果為true，則會從中加載_coverpage.md。
executeScript: true, //執行頁面上的腳本。只解析第一個腳本標記（演示）。如果存在Vue，則默認開啟。
loadSidebar: true, //_sidebar.md如果為真，則從_sidebar.md文件加載邊欄，否則從指定的路徑加載。
loadNavbar: true,//_navbar.md如果為真，則從_navbar.md文件加載navbar ，否則從指定的路徑加載。
mergeNavbar: true,//Navbar將在小屏幕上與側邊欄合並。
maxLevel: 4,//最大的內容表級別。
subMaxLevel: 2,//在自定義邊欄中添加目錄（TOC）。
ga: 'UA-106147152-1',
name: 'docsify',
search: {
noData: {
'/de-de/': 'Keine Ergebnisse!',
'/zh-cn/': '沒有結果!',
'/': 'No results!'
},
paths: 'auto',
placeholder: {
'/de-de/': 'Suche',
'/zh-cn/': '搜索',
'/': 'Search'
}
},
formatUpdated: '{MM}/{DD} {HH}:{mm}',
plugins: [
function(hook, vm) {
hook.beforeEach(function (html) {
var url = 'https://github.com/PYfive/docsify/blob/master/' + vm.route.file
var editHtml = '[:memo: Edit Document](' + url + ')\n'
return html
+ '\n----\n'
+ 'Last modified {docsify-updated} '
+ editHtml
})
}
]
}
</script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
<script src="//unpkg.com/docsify/lib/plugins/ga.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-bash.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-markdown.min.js"></script>
<script src="//unpkg.com/prismjs/components/prism-nginx.min.js"></script>
</body>
</html>
運行
docsify serve --port 4000
訪問 http:/localhost:4000 即可查看頁面效果
總結
docsify用法和gitbook差不多，但是樣式比較好看，個人比較喜歡。