jyapayne/docsify
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Add logo (#28)

Browse source 
* Fix table style

* Add logo

* Update index.html

* Update doc
This commit is contained in:
cinwell.li 2016-12-18 15:30:50 +08:00 • committed by GitHub
commit 9ba989c86c
11 changed files with 45 additions and 33 deletions
Download patch file Download diff file Expand all files Collapse all files

0
docs/.nojekyll Normal file
View file

14
docs/README.md
View file

@ -1,9 +1,13 @@
# docsify
<p align="center">
<img alt="docsify" src="https://cloud.githubusercontent.com/assets/7565692/21292094/5c206de4-c533-11e6-9493-29ea67b01dde.png">
</p>
> A magical documentation site generator.
<p align="center">
A magical documentation site generator.
</p>
## Features
- Easy and lightweight
- Easy and lightweight (~12kB gzipped)
- Custom themes
- No build
@ -213,7 +217,7 @@ If you write a sub level list, it will generate a dropdown list.
- [chinese](/zh-cn)
```
### router
#### router
Hash router. You can replace `404.html` with `index.html`.
@ -221,7 +225,7 @@ Hash router. You can replace `404.html` with `index.html`.
<script src="/lib/docsify.js" data-router></script>
```
### auto2top
#### auto2top
Scroll to the top on changing hash.

BIN
docs/favicon.ico Normal file
View file

Binary file not shown.
Side by side

After

Width:  |  Height:  |  Size: 66 KiB

1
docs/index.html
View file

@ -3,6 +3,7 @@
<head>
<meta charset="UTF-8">
<title>docsify - A magical documentation site generator.</title>
<link rel="icon" href="favicon.ico">
<meta name="description" content="A magical documentation generator.">
<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="//unpkg.com/docsify/lib/themes/vue.css">

14
docs/zh-cn.md
View file

@ -1,11 +1,15 @@
# docsify
<p align="center">
<img alt="docsify" src="https://cloud.githubusercontent.com/assets/7565692/21292094/5c206de4-c533-11e6-9493-29ea67b01dde.png">
</p>
> 无需构建快速生成文档页
<p align="center">
无需构建快速生成文档页
</p>
## 特性
- 无需构建，写完 markdown 直接发布
- 支持自定义主题
- 容易使用并且轻量
- 容易使用并且轻量 (~12kB gzipped)
## 快速上手
@ -214,7 +218,7 @@ Sidebar 开关按钮
```
### router
#### router
开启 hash router 功能，此时可以创建 `index.html` 作为入口文件，同时多页面切换不会重新加载资源。资源路径会被替换成 `/#/` 的形式。
@ -222,7 +226,7 @@ Sidebar 开关按钮
<script src="/lib/docsify.js" data-router></script>
```
### auto2top
#### auto2top
切换路由时自动跳转到页面顶部