应用场景
快速以网站形式构建、发布软件的API手册或用户说明文档,方便用户使用你的软件,达到快速传播作用。
原理
通过前端js解析md文件,生成一个单页面文档网站
如何使用
通过markdown编辑器(推荐使用vscode编辑器)编辑好文档,放到相应的目录即可,前端js自动解析md文件,生成导航。
支持多语种、图片、文件、视频等
部署方式
方式一:使用django web框架
(1)下载docsify css和js静态文件
下载地址:https://github.com/docsifyjs/docsify/tree/master/lib
下载后,文件存放到下图对应的css和js目录下
(2) 构建一个web项目
使用django很容易搭建一个web项目,这里就不多说了。
(3)增加一个路由,指向文档首页
url(r'^$', TemplateView.as_view(template_name='index.html')),
(4)文档首页: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="/static/docs/css/vue.css">
{# <link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">#}
{# <link rel="stylesheet" href="//unpkg.com/docsify/themes/dark.css">#}
{# <link rel="stylesheet" href="//unpkg.com/docsify/themes/pure.css">#}
</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,
// 主题颜色,更换图标颜色
//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部署
由于都是静态文件,所以可以直接挂到nginx下面
步骤如下:
(1)安装nginx:yum install nginx
配置:vi /etc/nginx/nginx.conf,如下图,这里我直接将静态文件放到 /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
参考资料:
官方技术文档:
markdown语法:
https://docsify.js.org/#/zh-cn/helpers
markdown编辑器
下列代码编辑器或ide都支持markdown文件的编辑与预览
subline_text
vscode
pycharm idea