Update readme
This commit is contained in:
parent
e82b5c58bc
commit
e6ef1317c8
2 changed files with 4 additions and 6 deletions
|
|
@ -1,6 +1,5 @@
|
||||||
# docsify
|
# docsify [WIP]
|
||||||
[](https://travis-ci.org/QingWei-Li/docsify)
|
[](https://travis-ci.org/QingWei-Li/docsify)
|
||||||
[](https://coveralls.io/github/QingWei-Li/docsify?branch=master)
|
|
||||||
[](https://www.npmjs.com/package/docsify)
|
[](https://www.npmjs.com/package/docsify)
|
||||||
|
|
||||||
>🃏 A magical documentation site generator.
|
>🃏 A magical documentation site generator.
|
||||||
|
|
@ -10,7 +9,7 @@
|
||||||
- Custom themes and plugins
|
- Custom themes and plugins
|
||||||
|
|
||||||
## Quick start
|
## 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
|
404.html
|
||||||
|
|
||||||
|
|
|
||||||
|
|
@ -4,13 +4,12 @@
|
||||||
"description": "A magical documentation generator.",
|
"description": "A magical documentation generator.",
|
||||||
"main": "lib/docsify.js",
|
"main": "lib/docsify.js",
|
||||||
"files": [
|
"files": [
|
||||||
"lib",
|
"lib"
|
||||||
"themes"
|
|
||||||
],
|
],
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"build": "node build/build.js && uglifyjs lib/docsify.js -o lib/docsify.min.js",
|
"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'",
|
"dev": "nodemon -w src -x 'node build/build.js && node test/server.js'",
|
||||||
"test": "eslint src server"
|
"test": "eslint src test"
|
||||||
},
|
},
|
||||||
"keywords": [
|
"keywords": [
|
||||||
"doc",
|
"doc",
|
||||||
|
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue