使用docsify快速生成网站文档

应用场景

快速以网站形式构建、发布软件的API手册或用户说明文档,方便用户使用你的软件,达到快速传播作用。

原理

通过前端js解析md文件,生成一个单页面文档网站

如何使用

通过markdown编辑器(推荐使用vscode编辑器)编辑好文档,放到相应的目录即可,前端js自动解析md文件,生成导航。
支持多语种、图片、文件、视频等

部署方式

方式一:使用django web框架
(1)下载docsify css和js静态文件
下载地址:https://github.com/docsifyjs/docsify/tree/master/lib

下载后,文件存放到下图对应的css和js目录下

image.png

(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


image.png

(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

参考资料:

官方技术文档:

https://docsify.js.org

markdown语法:

http://www.markdown.cn/

https://docsify.js.org/#/zh-cn/helpers

markdown编辑器

下列代码编辑器或ide都支持markdown文件的编辑与预览

subline_text

vscode

pycharm idea

配置导航和多页面

https://docsify.js.org

最终效果

image.png
image.png
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容

  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    aimaile阅读 26,701评论 6 427
  • # Python 资源大全中文版 我想很多程序员应该记得 GitHub 上有一个 Awesome - XXX 系列...
    小迈克阅读 8,145评论 1 3
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 135,404评论 19 139
  • 离机票上的日子还有11天 原来以为今年是飞不成的 当时刚从青海出差回来,庞大的项目不知道几时能结束,年假只能在元旦...
    amy430阅读 3,118评论 2 1
  • 仿佛不经意般 梦里让我遇到了你 就在一个转身的距离 你的笑点亮了我的双眼 依旧那么瘦弱的身体 依旧一脸的慈爱温情 ...
    李玫阅读 2,870评论 0 1