Update readme

This commit is contained in:
qingwei.li 2016-11-20 22:32:32 +08:00
parent e82b5c58bc
commit e6ef1317c8
2 changed files with 4 additions and 6 deletions

View File

@ -1,6 +1,5 @@
# docsify
# docsify [WIP]
[![Build Status](https://travis-ci.org/QingWei-Li/docsify.svg?branch=master)](https://travis-ci.org/QingWei-Li/docsify)
[![Coverage Status](https://coveralls.io/repos/github/QingWei-Li/docsify/badge.svg?branch=master)](https://coveralls.io/github/QingWei-Li/docsify?branch=master)
[![npm](https://img.shields.io/npm/v/docsify.svg)](https://www.npmjs.com/package/docsify)
>🃏 A magical documentation site generator.
@ -10,7 +9,7 @@
- Custom themes and plugins
## Quick start
Such as [./docs](./docs), Just create `404.html` and `README.md` into `/docs`.
Such as [./docs](https://github.com/QingWei-Li/docsify/tree/master/docs), Create `404.html` and `README.md` into `/docs`.
404.html

View File

@ -4,13 +4,12 @@
"description": "A magical documentation generator.",
"main": "lib/docsify.js",
"files": [
"lib",
"themes"
"lib"
],
"scripts": {
"build": "node build/build.js && uglifyjs lib/docsify.js -o lib/docsify.min.js",
"dev": "nodemon -w src -x 'node build/build.js && node test/server.js'",
"test": "eslint src server"
"test": "eslint src test"
},
"keywords": [
"doc",