應(yīng)用場景
快速以網(wǎng)站形式構(gòu)建存和、發(fā)布軟件的API手冊或用戶說明文檔，方便用戶使用你的軟件，達(dá)到快速傳播作用捐腿。
原理
通過前端js解析md文件纵朋，生成一個單頁面文檔網(wǎng)站
如何使用
通過markdown編輯器（推薦使用vscode編輯器）編輯好文檔，放到相應(yīng)的目錄即可茄袖，前端js自動解析md文件操软，生成導(dǎo)航。
支持多語種宪祥、圖片聂薪、文件、視頻等
部署方式
方式一：使用django web框架
（1）下載docsify css和js靜態(tài)文件
下載地址：https://github.com/docsifyjs/docsify/tree/master/lib
下載后蝗羊，文件存放到下圖對應(yīng)的css和js目錄下
（2） 構(gòu)建一個web項目
使用django很容易搭建一個web項目藏澳，這里就不多說了。
（3）增加一個路由肘交，指向文檔首頁
url(r'^$', TemplateView.as_view(template_name='index.html')),
（4）文檔首頁：index.html 內(nèi)容如下：
<!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="/static/docs/css/vue.css">
{# <link rel="stylesheet" >#}
{# <link rel="stylesheet" >#}
{# <link rel="stylesheet" >#}
</head>
<body>
<nav>
<a href="#/">中文</a>
<a href="#/en/">EN</a>
</nav>
<div id="app"></div>
<script>
window.$docsify = {
basePath:'/static/docs/',
loadSidebar:true,
subMaxLevel:3,
search: 'auto',
loadNavbar: true,
coverpage: true,
auto2top: true,
// 主題顏色笆载，更換圖標(biāo)顏色
//themeColor: '#3F51B5',
autoHeader: true,
executeScript: true,
mergeNavbar: true,
name: 'project name',
repo: 'https://github.com/',//項目的github地址
formatUpdated: '{MM}/{DD} {HH}:{mm}',
//routerMode: 'history'
}
</script>
<script src="/static/docs/js/docsify.min.js"></script>
<script src="/static/docs/js/search.js"></script>
</body>
</html>
方式二 nginx部署
由于都是靜態(tài)文件，所以可以直接掛到nginx下面
步驟如下：
（1）安裝nginx：yum install nginx
配置：vi /etc/nginx/nginx.conf涯呻，如下圖凉驻，這里我直接將靜態(tài)文件放到 /usr/share/nginx/html 下，端口號改為了8000
（2）檢查nginx配置： nginx -t
（3）啟動nginx：systemctl start nginx
nginx常用命令：
重啟： systemctl reload nginx
查找nginx安裝目錄：rpm -ql nginx
查找nginx有沒有啟動： netstat -anp |grep :80
ps -ef|grep nginx
參考資料：
官方技術(shù)文檔：
markdown語法：
https://docsify.js.org/#/zh-cn/helpers
markdown編輯器
下列代碼編輯器或ide都支持markdown文件的編輯與預(yù)覽
subline_text
vscode
pycharm idea
配置導(dǎo)航和多頁面
最終效果
