Remove 404.html
This commit is contained in:
qingwei.li
parent
383b976ddd
commit
67f9083ff7
3 changed files with 16 additions and 39 deletions
|
|
@ -42,12 +42,6 @@ index.html
|
||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
Or create a `404.html` and `README.md` into `/docs`. Just remove `data-router`
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script src="//unpkg.com/docsify"></script>
|
|
||||||
```
|
|
||||||
|
|
||||||
## CDN
|
## CDN
|
||||||
- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
|
- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
|
||||||
- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
|
- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
|
||||||
|
|
|
||||||
|
|
@ -8,7 +8,7 @@ mkdir docs && cd docs
|
||||||
```
|
```
|
||||||
|
|
||||||
### Create entry file
|
### Create entry file
|
||||||
Create a `404.html` file
|
Create a `index.html` file
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
|
|
@ -20,7 +20,7 @@ Create a `404.html` file
|
||||||
<body>
|
<body>
|
||||||
<div id="app"></div>
|
<div id="app"></div>
|
||||||
</body>
|
</body>
|
||||||
<script src="//unpkg.com/docsify"></script>
|
<script src="//unpkg.com/docsify" data-router></script>
|
||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -77,27 +77,18 @@ Minified files
|
||||||
## More
|
## More
|
||||||
|
|
||||||
### Multiple pages
|
### Multiple pages
|
||||||
If you need other pages, directly create the markdown file, such as `guide.md` is `/guide`.
|
If you need other pages, directly create the markdown file, such as `guide.md` is `/#/guide`.
|
||||||
|
|
||||||
### Navbar
|
### Navbar
|
||||||
Code in `404.html`
|
Code in `index.html`
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<nav>
|
<nav>
|
||||||
<a href="/docsify/">En</a>
|
<a href="/#/docsify/">En</a>
|
||||||
<a href="/docsify/zh-cn">中文</a>
|
<a href="/#/docsify/zh-cn">中文</a>
|
||||||
</nav>
|
</nav>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Hash router
|
|
||||||
`404.html` is not SEO friendly, you can replace it use `index.html` and `data-router` [issue#7](https://github.com/QingWei-Li/docsify/issues/7)
|
|
||||||
|
|
||||||
index.html
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script src="//unpkg.com/docsify" data-router></script>
|
|
||||||
```
|
|
||||||
|
|
||||||
### CDN
|
### CDN
|
||||||
- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
|
- UNPKG [https://unpkg.com/docsify/](https://unpkg.com/docsify/)
|
||||||
- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
|
- jsDelivr [http://www.jsdelivr.com/projects/docsify](http://www.jsdelivr.com/projects/docsify)
|
||||||
|
|
@ -242,7 +233,7 @@ If you write a sub level list, it will generate a dropdown list.
|
||||||
|
|
||||||
#### router
|
#### router
|
||||||
|
|
||||||
Hash router. You can replace `404.html` with `index.html`.
|
Hash router.
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<script src="/lib/docsify.js" data-router></script>
|
<script src="/lib/docsify.js" data-router></script>
|
||||||
|
|
|
||||||
|
|
@ -14,7 +14,7 @@ mkdir docs && cd docs
|
||||||
```
|
```
|
||||||
|
|
||||||
### 创建入口文件
|
### 创建入口文件
|
||||||
创建一个 `404.html` 文件，内容为
|
创建一个 `index.html` 文件，内容为
|
||||||
```html
|
```html
|
||||||
<!DOCTYPE html>
|
<!DOCTYPE html>
|
||||||
<html>
|
<html>
|
||||||
|
|
@ -25,7 +25,7 @@ mkdir docs && cd docs
|
||||||
<body>
|
<body>
|
||||||
<div id="app"></div>
|
<div id="app"></div>
|
||||||
</body>
|
</body>
|
||||||
<script src="//unpkg.com/docsify"></script>
|
<script src="//unpkg.com/docsify" data-router></script>
|
||||||
</html>
|
</html>
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
@ -66,7 +66,7 @@ docsify serve docs
|
||||||
更多选项参考 [docsify-cli](https://github.com/QingWei-Li/docsify-cli)
|
更多选项参考 [docsify-cli](https://github.com/QingWei-Li/docsify-cli)
|
||||||
|
|
||||||
## 主题
|
## 主题
|
||||||
目前提供 vue.css 和 buble.css，直接修改 `404.html` 里的 cdn 地址即可
|
目前提供 vue.css 和 buble.css，直接修改 `index.html` 里的 cdn 地址即可
|
||||||
```html
|
```html
|
||||||
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
|
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
|
||||||
<link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
|
<link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css">
|
||||||
|
|
@ -82,26 +82,18 @@ docsify serve docs
|
||||||
## 更多功能
|
## 更多功能
|
||||||
|
|
||||||
### 多页面
|
### 多页面
|
||||||
`README.md` 作为主页面，如果需要其他页面，直接在文档目录下创建对应的 `*.md` 文件，例如创建一个 `guide.md` 那么对应的路由就是 `/guide`。
|
`README.md` 作为主页面，如果需要其他页面，直接在文档目录下创建对应的 `*.md` 文件，例如创建一个 `guide.md` 那么对应的路由就是 `/#/guide`。
|
||||||
|
|
||||||
### 导航
|
### 导航
|
||||||
导航需要自己写在 `404.html` 文件里，效果参考本文档
|
导航需要自己写在 `index.html` 文件里，效果参考本文档
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<nav>
|
<nav>
|
||||||
<a href="/docsify/">En</a>
|
<a href="/#/docsify/">En</a>
|
||||||
<a href="/docsify/zh-cn">中文</a>
|
<a href="/#/docsify/zh-cn">中文</a>
|
||||||
</nav>
|
</nav>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Hash router
|
|
||||||
`404.html` 对 SEO 不友好, 你可以用 `index.html` 代替并开启 `hash router` 功能。 [issue#7](https://github.com/QingWei-Li/docsify/issues/7)
|
|
||||||
|
|
||||||
index.html
|
|
||||||
|
|
||||||
```html
|
|
||||||
<script src="//unpkg.com/docsify" data-router></script>
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
### CDN
|
### CDN
|
||||||
|
|
@ -133,7 +125,7 @@ index.html
|
||||||
### 配置参数
|
### 配置参数
|
||||||
|
|
||||||
#### repo
|
#### repo
|
||||||
参考本文档的右上角的 GitHub 图标，如果要开启的话，将 `404.html` 里的 script 改成
|
参考本文档的右上角的 GitHub 图标，如果要开启的话，将 `index.html` 里的 script 改成
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<script src="//unpkg.com/docsify" data-repo="your/repo"></script>
|
<script src="//unpkg.com/docsify" data-repo="your/repo"></script>
|
||||||
|
|
@ -246,7 +238,7 @@ Sidebar 开关按钮
|
||||||
|
|
||||||
#### router
|
#### router
|
||||||
|
|
||||||
开启 hash router 功能，此时可以创建 `index.html` 作为入口文件，同时多页面切换不会重新加载资源。资源路径会被替换成 `/#/` 的形式。
|
开启 hash router 功能，同时多页面切换不会重新加载资源。资源路径会被替换成 `/#/` 的形式。
|
||||||
|
|
||||||
```html
|
```html
|
||||||
<script src="/lib/docsify.js" data-router></script>
|
<script src="/lib/docsify.js" data-router></script>
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue