docsify – 无需构建快速生成文档网站

微信扫一扫,分享到朋友圈

docsify – 无需构建快速生成文档网站

技术图片

docsify

无需构建快速生成文档页

网站:https://github.com/qingwei-li…
文档:https://docsify.js.org/zh-cn

特性

  • 无需构建,写完 markdown 直接发布

  • 支持自定义主题

  • 容易使用并且轻量

快速上手

创建项目

新建一个空项目,接着创建一个 docs 目录并进入到 docs 目录下

mkdir my-project && cd my-project
mkdir docs && cd docs

创建入口文件

创建一个 404.html 文件,内容为

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<link rel="stylesheet" href="http://unpkg.com/docsify/themes/vue.css">
</head>
<body>
<div id="app"></div>
</body>
<script src="http://unpkg.com/docsify"></script>
</html>

新建 README.md 文件,作为主页面

# Title
## balabala

部署!

将项目 push 到 GitHub 仓库后到设置页面开启 GitHub Pages 功能,选择 docs/ 选项
技术图片

命令行工具

方便快速创建文档目录,会读取项目的 package.json 里的选项作为 docsify 的配置,支持本地预览。

安装

npm i docsify-cli -g

初始化文档

默认初始化在当前目录,推荐将文档放在 docs 目录下

docsify init docs

启动本地服务

启动一个 server 方便预览,打开 http://localhost:3000

docsify serve docs

更多选项参考 docsify-cli

主题

目前提供 vue.css 和 buble.css,直接修改 404.html 里的 cdn 地址即可

<link rel="stylesheet" href="http://unpkg.com/docsify/themes/vue.css">
<link rel="stylesheet" href="http://unpkg.com/docsify/themes/buble.css">

压缩版

<link rel="stylesheet" href="http://unpkg.com/docsify/lib/themes/vue.css">
<link rel="stylesheet" href="http://unpkg.com/docsify/lib/themes/buble.css">

更多功能

多页面

README.md 作为主页面,如果需要其他页面,直接在文档目录下创建对应的 *.md 文件,例如创建一个 guide.md 那么对应的路由就是 /guide

导航

导航需要自己写在 404.html 文件里,效果参考本文档

<nav>
<a href="http://mamicode.com/docsify/">En</a>
<a href="http://mamicode.com/docsify/zh-cn">中文</a>
</nav>

配置参数

repo

参考本文档的右上角的 GitHub 图标,如果要开启的话,将 404.html 里的 script 改成

<script src="http://unpkg.com/docsify" data-repo="your/repo"></script>

max-level

目录最大展开层级,默认值为 6

<script src="http://unpkg.com/docsify" data-max-level="6"></script>

el

替换节点元素,默认为 #app

<script src="http://unpkg.com/docsify" data-el="#app"></script>

sidebar-toggle

Sidebar 开关按钮

<script src="http://unpkg.com/docsify" data-sidebar-toggle></script>

sidebar

设置后 TOC 功能将不可用,适合导航较多的文档,data-sidebar 传入全局变量名。

技术图片

<script>
window.sidebar = [
{ slug: ‘/‘, title: ‘Home‘ },
{
slug: ‘/pageA‘,
title: ‘page A‘,
children: [
{ slug: ‘/pageA/childrenB‘, title: ‘children B‘ }
]
},
{ slug: ‘/PageC‘, title: ‘Page C‘ }
]
</script>
<script src="http://mamicode.com/lib/docsify.js" data-sidebar="sidebar"></script>

load-sidebar

读取侧边栏配置文件,如果配置,默认加载当前目录下的 _sidebar.md。如果文件不存在,会显示 TOC 作为侧边栏内容。如果你有二级目录,也应该放置一份配置文件。

<script src="http://mamicode.com/lib/docsify.js" data-load-sidebar></script>

你可以指定侧边栏文件名

<script src="http://mamicode.com/lib/docsify.js" data-load-sidebar="_sidebar.md"></script>

_sidebar.md 的内容可以是这样的

- [Home](/)
- [Installation](/installation)
- Essentials
- [Getting Started](/getting-started)
- [Dynamic Route Matching](/dynamic-matching)
- [Nested Routes](/nested-routes)
- [Programmatic Navigation](/navigation)
- [Named Routes](/named-routes)
- [Named Views](/named-views)
- [Redirect and Alias](/redirect-and-alias)
- [HTML5 History Mode](/history-mode)

load-navbar

读取导航配置文件,如果配置,默认加载当前目录下的 _navbar.md。如果文件不存在,会显示 html 里定义的导航栏。

<script src="http://mamicode.com/lib/docsify.js" data-load-navbar></script>

你可以指定导航栏文件名

<script src="http://mamicode.com/lib/docsify.js" data-load-navbar="_navbar.md"></script>

_navbar.md 的内容可以是这样

- [en](/)
- [中文](/zh-cn)

当然也支持二级列表,将生成一个下拉列表

- [download](/download)
- language
- [en](/)
- [中文](/zh-cn)

FAQ

为什么是 404.html 而不用 index.html

docsify 想要实现的是用最简单的方式 动态渲染内容

例如我有两个文档分别为 README.mdguide.md,如果我用 index.html 作为文件名,README.md 可以被正确的渲染因为我们已经规定它为首页文件,但是如果我们访问 my-domain.com/guide 想要得到的结果是 guide.md 的内容,它将无法工作,因为目录下并不存在一个 guide.html 的文件。

但是 GitHub Pages 服务器找不到资源, 就会回退并渲染 404.html 文件。?


网站:https://github.com/qingwei-li…
文档:https://docsify.js.org/zh-cn

本文转载于:猿2048?https://www.mk2048.com/blog/blog.php?id=hh10ijhihaa

docsify – 无需构建快速生成文档网站

原文地址:https://www.cnblogs.com/homehtml/p/12579490.html

罗永浩抖音带货微博被投诉遭删除:后续来了

上一篇

linux ping命令

下一篇

你也可能喜欢

docsify – 无需构建快速生成文档网站

长按储存图像,分享给朋友