mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
Add logo (#28)
* Fix table style * Add logo * Update index.html * Update doc
This commit is contained in:
cinwell.li
GitHub
parent
ab34cc97f9
commit
9ba989c86c
@ -1,3 +1,10 @@
|
||||
## 1.1.6
|
||||
### Features
|
||||
- Add logo 😂
|
||||
|
||||
### Bug fixes
|
||||
- Remove table background color
|
||||
|
||||
## 1.1.5
|
||||
### Features
|
||||
- Add table style
|
||||
|
||||
24
README.md
24
README.md
@ -1,15 +1,25 @@
|
||||
# docsify
|
||||
[](https://travis-ci.org/QingWei-Li/docsify)
|
||||
[](https://www.npmjs.com/package/docsify)
|
||||
<p align="center">
|
||||
<a href="https://docsify.js.org">
|
||||
<img alt="docsify" src="./media/docsify.png">
|
||||
</a>
|
||||
</p>
|
||||
|
||||
>🃏 A magical documentation site generator.
|
||||
<p align="center">
|
||||
A magical documentation site generator.
|
||||
</p>
|
||||
|
||||
<p align="center">
|
||||
<a href="https://travis-ci.org/QingWei-Li/docsify"><img alt="Travis Status" src="https://travis-ci.org/QingWei-Li/docsify.svg?branch=master"></a>
|
||||
<a href="https://www.npmjs.com/package/docsify"><img alt="npm" src="https://img.shields.io/npm/v/docsify.svg"></a>
|
||||
<a href="https://beerpay.io/QingWei-Li/docsify"><img alt="npm" src="https://beerpay.io/QingWei-Li/docsify/badge.svg?style=beer-square"></a>
|
||||
</p>
|
||||
|
||||
## Links
|
||||
- [Documentation](https://docsify.js.org)
|
||||
- [CLI](https://github.com/QingWei-Li/docsify-cli)
|
||||
|
||||
## Features
|
||||
- Easy and lightweight
|
||||
- Easy and lightweight (~12kB gzipped)
|
||||
- Custom themes
|
||||
- No build
|
||||
|
||||
@ -65,7 +75,3 @@ These open-source projects are using docsify to generate their sites. Pull reque
|
||||
## License
|
||||
MIT
|
||||
|
||||
## Support on Beerpay
|
||||
Hey dude! Help me out for a couple of :beers:!
|
||||
|
||||
[](https://beerpay.io/QingWei-Li/docsify) [](https://beerpay.io/QingWei-Li/docsify?focus=wish)
|
||||
0
docs/.nojekyll
Normal file
0
docs/.nojekyll
Normal 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
BIN
docs/favicon.ico
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 66 KiB |
@ -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">
|
||||
|
||||
@ -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
|
||||
|
||||
切换路由时自动跳转到页面顶部
|
||||
|
||||
|
||||
BIN
media/docsify.png
Normal file
BIN
media/docsify.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 9.6 KiB |
@ -241,6 +241,7 @@ main {
|
||||
overflow: auto;
|
||||
border-spacing: 0;
|
||||
border-collapse: collapse;
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
.markdown-section th {
|
||||
@ -255,7 +256,6 @@ main {
|
||||
}
|
||||
|
||||
.markdown-section tr {
|
||||
background-color: #fff;
|
||||
border-top: 1px solid #ccc;
|
||||
&:nth-child(2n) {
|
||||
background-color: #f8f8f8;
|
||||
|
||||
@ -54,6 +54,8 @@ body {
|
||||
.markdown-section ul,
|
||||
.markdown-section ol {
|
||||
word-spacing: 0.05em;
|
||||
line-height: 1.6em;
|
||||
margin: 0 0 1em 0;
|
||||
}
|
||||
|
||||
.markdown-section h1 {
|
||||
@ -95,13 +97,6 @@ body {
|
||||
margin: 1.2em 0;
|
||||
}
|
||||
|
||||
.markdown-section p,
|
||||
.markdown-section ul,
|
||||
.markdown-section ol {
|
||||
margin: 0 0 1em 0;
|
||||
line-height: 1.5;
|
||||
}
|
||||
|
||||
.markdown-section ul,
|
||||
.markdown-section ol {
|
||||
padding-left: 1.5em;
|
||||
|
||||
@ -55,12 +55,6 @@ body {
|
||||
font-weight: 600;
|
||||
}
|
||||
|
||||
.markdown-section p,
|
||||
.markdown-section ul,
|
||||
.markdown-section ol {
|
||||
word-spacing: 0.05em;
|
||||
}
|
||||
|
||||
.markdown-section h1 {
|
||||
margin: 0 0 1em;
|
||||
font-size: 2em;
|
||||
@ -100,6 +94,7 @@ body {
|
||||
.markdown-section ul,
|
||||
.markdown-section ol {
|
||||
line-height: 1.6em;
|
||||
word-spacing: 0.05em;
|
||||
}
|
||||
|
||||
.markdown-section ul,
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user