feat: init ocsify-server-renderer

2017-05-29 22:24:38 +08:00 · 2017-05-29 22:24:38 +08:00 · 6dea685fee
commit 6dea685fee
parent f095eb888f
8 changed files with 124 additions and 7 deletions
--- a/packages/docsify-server-renderer/README.md
+++ b/packages/docsify-server-renderer/README.md
@ -0,0 +1,49 @@
+# docsify-server-renderer
+
+## Install
+
+```bash
+yarn add docsify-server-render
+```
+
+## Usage
+
+```js
+var Renderer = require('docsify-server-renderer')
+var readFileSync = require('fs').readFileSync
+var resolve = require('path').resolve
+
+// init
+var renderer = new Renderer({
+  template: readFileSync('./index.template.html', 'utf-8').,
+  path: resolve(_dirname, './docs'),
+  config: {
+    name: 'docsify',
+    repo: 'qingwei-li/docsify'
+  }
+  //,cache: () => {}
+})
+
+renderer.renderToString({ url })
+  .then(html => {})
+  .catch(err => {})
+```
+
+*index.template.html*
+
+```html
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="UTF-8">
+  <title>docsify</title>
+  <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">
+  <link rel="stylesheet" href="//unpkg.com/docsify/themes/buble.css" title="buble" disabled>
+</head>
+<body>
+  <div id="app"></div>
+  <!--inject-docsify-config-->
+  <script src="//unpkg.com/docsify/lib/docsify.js"></script>
+</body>
+</html>
+```