使用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
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容

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