docsify/README.md

30 lines
712 B
Markdown
Raw Normal View History

2016-11-20 22:32:32 +08:00
# docsify [WIP]
2016-11-20 22:39:07 +08:00
[![Build Status](https://travis-ci.org/QingWei-Li/docsify.svg?branch=master)](https://travis-ci.org/QingWei-Li/docwsify)
2016-11-20 15:56:37 +08:00
[![npm](https://img.shields.io/npm/v/docsify.svg)](https://www.npmjs.com/package/docsify)
>🃏 A magical documentation site generator.
## Features
- Easy and lightweight
- Custom themes and plugins
## Quick start
2016-11-20 22:32:32 +08:00
Such as [./docs](https://github.com/QingWei-Li/docsify/tree/master/docs), Create `404.html` and `README.md` into `/docs`.
2016-11-20 15:56:37 +08:00
404.html
```html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
2016-11-20 22:49:32 +08:00
<link rel="stylesheet" href="//unpkg.com/docsify/themes/vue.css">
2016-11-20 15:56:37 +08:00
</head>
<body></body>
2016-11-22 22:46:44 +08:00
<script src="//unpkg.com/docsify"></script>
2016-11-20 15:56:37 +08:00
</html>
```
## License
MIT