Skip to content

Commit 9cb6c2d

Browse files
committed
first commit
0 parents commit 9cb6c2d

19 files changed

+1889
-0
lines changed

README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
## docsify
2+
3+
> 一个神奇的文档网站生成工具
4+
5+
## 是什么
6+
7+
docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 `.md` 转成 `.html` 文件,所有转换工作都是在运行时进行。
8+
9+
这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 `.html` 文件“污染” commit 记录,只需要创建一个 `index.html` 就可以开始写文档而且直接[部署在 GitHub Pages](zh-cn/deploy.md)
10+
11+
查看[快速开始](zh-cn/quickstart.md)了解详情。
12+
13+
## 特性
14+
15+
- 无需构建,写完文档直接发布
16+
- 容易使用并且轻量 (~19kB gzipped)
17+
- 智能的全文搜索
18+
- 提供多套主题
19+
- 丰富的 API
20+
- 支持 Emoji
21+
- 兼容 IE10+
22+
- 支持 SSR ([example](https://github.com/docsifyjs/docsify-ssr-demo))
23+
24+
## 例子
25+
26+
可以查看 [Showcase](https://github.com/docsifyjs/docsify/#showcase) 来了解使用 docsify 的文档项目。
27+
28+
## 捐赠
29+
30+
如果你觉得 docsify 对你有帮助,或者想对我微小的工作一点资瓷,欢迎给我[捐赠](https://github.com/QingWei-Li/donate)
31+
32+
## Community
33+
34+
Users and development team are in the [Gitter](https://gitter.im/docsifyjs/Lobby).

_sidebar.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
* 入门
2+
3+
* [快速开始](zh-cn/quickstart.md)
4+
* [多页文档](zh-cn/more-pages.md)
5+
* [定制导航栏](zh-cn/custom-navbar.md)
6+
* [封面](zh-cn/cover.md)
7+
8+
* 定制化
9+
10+
* [配置项](zh-cn/configuration.md)
11+
* [主题](zh-cn/themes.md)
12+
* [插件列表](zh-cn/plugins.md)
13+
* [开发插件](zh-cn/write-a-plugin.md)
14+
* [Markdown 配置](zh-cn/markdown.md)
15+
* [代码高亮](zh-cn/language-highlight.md)
16+
17+
* 指南
18+
19+
* [部署](zh-cn/deploy.md)
20+
* [文档助手](zh-cn/helpers.md)
21+
* [兼容 Vue](zh-cn/vue.md)
22+
* [CDN](zh-cn/cdn.md)
23+
* [离线模式(PWA)](zh-cn/pwa.md)
24+
* [服务端渲染 (SSR)](zh-cn/ssr.md)
25+
* [文件嵌入<sup style="color:red">(new)<sup>](zh-cn/embed-files.md)
26+
27+
* [Awesome docsify](zh-cn/awesome.md)
28+
* [Changelog](zh-cn/changelog.md)

cdn.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# CDN
2+
3+
推荐使用 [unpkg](//unpkg.com) —— 能及时获取到最新版。
4+
5+
## 获取最新版本
6+
7+
根据 UNPKG 的规则,不指定特定版本号时将引入最新版。
8+
9+
```html
10+
<!-- 引入 css -->
11+
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
12+
13+
<!-- 引入 script -->
14+
<script src="//unpkg.com/docsify/lib/docsify.js"></script>
15+
```
16+
17+
## 获取指定版本
18+
19+
如果担心频繁地版本更新又可能引入未知 Bug,我们也可以使用具体的版本。规则是 `//unpkg.com/docsify@VERSION/`
20+
21+
```html
22+
<!-- 引入 css -->
23+
<link rel="stylesheet" href="//unpkg.com/docsify@2.0.0/themes/vue.css">
24+
25+
<!-- 引入 script -->
26+
<script src="//unpkg.com/docsify@2.0.0/lib/docsify.js"></script>
27+
```
28+
29+
!> 指定 *VERSION*`latest` 可以强制每次都请求最新版本。
30+
31+
## 压缩版
32+
33+
CSS 的压缩文件位于 `/lib/themes/` 目录下
34+
35+
```html
36+
<link rel="stylesheet" href="//unpkg.com/docsify/lib/themes/vue.css">
37+
```
38+
39+
JS 的压缩文件是原有文件路径的基础上加 `.min`后缀
40+
41+
```html
42+
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
43+
```
44+
45+
## 其他 CDN
46+
47+
- http://www.bootcdn.cn/docsify (支持国内)
48+
- https://cdn.jsdelivr.net/npm/docsify/ (国内外都支持)
49+
- https://cdnjs.com/libraries/docsify

0 commit comments

Comments
 (0)