mirror of
https://github.com/docsifyjs/docsify.git
synced 2025-12-08 19:55:52 +00:00
Update readme
This commit is contained in:
parent
e82b5c58bc
commit
e6ef1317c8
@ -1,6 +1,5 @@
|
||||
# docsify
|
||||
# docsify [WIP]
|
||||
[](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.
|
||||
@ -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
|
||||
|
||||
|
||||
@ -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",
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user