diff --git a/README.md b/README.md index 7fd0b9122..030ea60a6 100644 --- a/README.md +++ b/README.md @@ -22,7 +22,7 @@ Such as [./docs](https://github.com/QingWei-Li/docsify/tree/master/docs), Create - + ``` diff --git a/docs/404.html b/docs/404.html index bb8343c13..ad5770241 100644 --- a/docs/404.html +++ b/docs/404.html @@ -7,6 +7,6 @@ - + diff --git a/docs/README.md b/docs/README.md deleted file mode 120000 index 32d46ee88..000000000 --- a/docs/README.md +++ /dev/null @@ -1 +0,0 @@ -../README.md \ No newline at end of file diff --git a/docs/README.md b/docs/README.md new file mode 100644 index 000000000..030ea60a6 --- /dev/null +++ b/docs/README.md @@ -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 + + + + + + + + + + + +``` + + +## License +MIT diff --git a/package.json b/package.json index 45b43875a..941eb473e 100644 --- a/package.json +++ b/package.json @@ -1,10 +1,12 @@ { "name": "docsify", - "version": "0.0.1", + "version": "0.0.2", "description": "A magical documentation generator.", "main": "lib/docsify.js", "files": [ - "lib" + "lib", + "src", + "themes" ], "scripts": { "build": "node build/build.js && uglifyjs lib/docsify.js -o lib/docsify.min.js", diff --git a/test/themes b/test/themes index 4ce4409e5..de900312e 120000 --- a/test/themes +++ b/test/themes @@ -1 +1 @@ -../src/themes \ No newline at end of file +../themes \ No newline at end of file diff --git a/src/themes/buble.css b/themes/buble.css similarity index 100% rename from src/themes/buble.css rename to themes/buble.css diff --git a/src/themes/vue.css b/themes/vue.css similarity index 100% rename from src/themes/vue.css rename to themes/vue.css