mirror of
https://gitee.com/docsifyjs/docsify.git
synced 2024-12-03 04:31:20 +08:00
34 lines
966 B
Markdown
34 lines
966 B
Markdown
|
# docsify
|
||
|
|
[](https://travis-ci.org/QingWei-Li/docsify)
|
||
|
|
[](https://coveralls.io/github/QingWei-Li/docsify?branch=master)
|
||
|
|
[](https://www.npmjs.com/package/docsify)
|
||
|
|
|
||
|
|
>🃏 A magical documentation site generator.
|
||
|
|
|
||
|
|
## Features
|
||
|
|
- Easy and lightweight
|
||
|
|
- Custom themes and plugins
|
||
|
|
|
||
|
|
## Quick start
|
||
|
|
Such as [./docs](./docs), Just create `404.html` and `README.md` into `/docs`.
|
||
|
|
|
||
|
|
404.html
|
||
|
|
|
||
|
|
```html
|
||
|
|
<!DOCTYPE html>
|
||
|
|
<html>
|
||
|
|
<head>
|
||
|
|
<meta charset="UTF-8">
|
||
|
|
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
|
||
|
|
</head>
|
||
|
|
<body></body>
|
||
|
|
<script src="//unpkg.com/marked/marked.min.js"></script>
|
||
|
|
<script src="//unpkg.com/highlight.js/lib/highlight.js"></script>
|
||
|
|
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
|
||
|
|
</html>
|
||
|
|
```
|
||
|
|
|
||
|
|
|
||
|
|
## License
|
||
|
|
MIT
|