Compare commits

..
4 Commits
Author SHA1 Message Date
qingwei.li 798fcdb6e0 -> v0.0.2 2016-11-20 22:50:02 +08:00
qingwei.li deb05a2488 fix theme path 2016-11-20 22:49:32 +08:00
qingwei.li 6bc039a813 fix demo 2016-11-20 22:45:17 +08:00
qingwei.li 384dec2707 Add docs 2016-11-20 22:41:18 +08:00
7 changed files with 39 additions and 6 deletions
+1 -1
View File
@@ -22,7 +22,7 @@ Such as [./docs](https://github.com/QingWei-Li/docsify/tree/master/docs), Create
</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/prismjs/prism.js"></script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</html>
```
+1 -1
View File
@@ -7,6 +7,6 @@
</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/prismjs/prism.js"></script>
<script src="//unpkg.com/docsify/lib/docsify.js"></script>
</html>
-1
View File
@@ -1 +0,0 @@
../README.md
+32
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/prismjs/prism.js"></script>
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
</html>
```
## License
MIT
+4 -2
View File
@@ -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",
+1 -1
View File
@@ -1 +1 @@
../src/themes
../themes