简介
docsify 直接通过 JS
解析 Markdown
文件, 而不必编译生成 html,css,js
等静态资源文件。
它可以自动地将 Markdown 中的标题生成目录,配合 GitHub Pages
或 码云 的 Gitee Pages
, 可以快速搭建一个小型文档网站。
快速开始
# 安装
npm i docsify-cli -g
# 初始化文档项目
docsify init ./docs
# 开启本地调试 http://localhost:3000
docsify serve docs
配置项
- name: 文档标题,会显示在侧边栏顶部。
- homepage: 首页Markdown文件路径(以
.md
结尾),可以是相对路径或URL网址 - basePath: 文档加载的根路径(以
/
结尾),可以是二级路径或URL网址路径
示例
入口文件: index.html
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<title>EasyIM在线文档</title>
<meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
<meta name="description" content="Description">
<meta name="viewport" content="width=device-width, initial-scale=1.0, minimum-scale=1.0">
<link rel="stylesheet" href="//cdn.jsdelivr.net/npm/docsify@4/lib/themes/vue.css">
</head>
<body>
<div id="app"></div>
<script>
window.$docsify = {
coverpage: true,
coverpage: 'coverpage.md',
onlyCover: false,
maxLevel: 3,
name: 'EasyIM',
repo: 'https://github.com/iotames/easyim/',
homepage: 'https://raw.githubusercontent.com/iotames/easyim/master/README.md',
search: {
maxAge: 86400000, // 过期时间,一天,单位毫秒
placeholder: '搜索',
noData: '找不到搜索数据!',
},
}
</script>
<!-- Docsify v4 -->
<script src="//cdn.jsdelivr.net/npm/docsify@4"></script>
<script src="//cdn.jsdelivr.net/npm/docsify/lib/plugins/search.min.js"></script>
</body>
</html>
首页封面文件: coverpage.md
<!-- ![logo](_media/icon.svg) -->
# EasyIM <small>1.0 Beta</small>
> 一款简单的即时通讯服务器
- 纯Go语言实现,Linux, Win, IOS 全平台支持
- 默认 sqlite3 本地存储,无需新建数据库
- 支持常规 TCP 和 WebSocket 长连接
- 支持 json 和 protobuf 数据格式
[GitHub](https://github.com/iotames/easyim/)
[Get Started](#简介)
GitHub项目地址 https://github.com/docsifyjs/docsify/
项目主页 https://docsify.js.org/