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

Add docs

Browse source
This commit is contained in:
qingwei.li 2016-11-20 22:41:18 +08:00
commit 384dec2707
1 changed files with 32 additions and 1 deletions
Download patch file Download diff file Expand all files Collapse all files

1
docs/README.md
View file

@ -1 +0,0 @@
../README.md

32
docs/README.md Normal file
View file

@ -0,0 +1,32 @@
# docsify [WIP]
[![Build Status](https://travis-ci.org/QingWei-Li/docsify.svg?branch=master)](https://travis-ci.org/QingWei-Li/docwsify)
[![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
Such as [./docs](https://github.com/QingWei-Li/docsify/tree/master/docs), 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