@demosify/core
Create a playground to show demos of your projects.
Last updated 3 months ago by spritejs .
MIT · Original npm · Tarball · package.json
$ cnpm install @demosify/core 
SYNC missed versions from official npm registry.

???????? website | ???????? online demo

DEMOSIFY

Create a playground to show the demos of your project.

Quick start

  1. install @demosify/core
npm install @demosify/core --save-dev
  1. Create .demosrc.js file in your project root.
module.exports = {
  name: 'YOUR PROJECT NAME',
}
  1. Create demos directory in your project root. Add your demos in demos directory.
mkdir demos
mkdir demos/demo1
  1. Create a config.js file in each of your demos, e.g. demos/demo1.
// config.js
const javascript = `console.log('this is a demo')`;

export default {
  javascript,
}
  1. Create a .demoList.json file in your demos directory. Specify all your demos show in sidebar.
[
  "demo1",
  // ...
]
  1. Add NPM scripts in your package.json:
  "scripts": {
    "demo:dev": "demosify --serve",
    "demo:prod": "demosify --prod"
  }
  1. Run npm run demo:dev, visit http://localhost:3000. You will see the playground. ✌????

Load sample files

You can load sample files though config.js.

export default async () => {
  const [javascript, html, css] = await Promise.all([
    import('!raw-loader!./index.js'),
    import('!raw-loader!./index.html'),
    import('!raw-loader!./style.css'),
  ]);

  return {
    javascript,
    html,
    css,
  }
}

Add index.js, index.html and style.css files in your demo directory.

console.log('This is a demo.');
<!DOCTYPE html>
<html lang="en">
<head>
  <meta charset="UTF-8">
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  <meta http-equiv="X-UA-Compatible" content="ie=edge">
  <title>DEMO</title>
</head>
<body>
  <div id="app"></div>
</body>
</html>
/* demo stylesheet */

body {
  background-color: red;
}

These files will be loaded to your playground.

Deploy

Run npm run demo:prod.

All the demos will be deploy to production into dist directory of your project.

Thanks to

Special thanks to Poi.

Demosify is inspired and powered by Poi.

Current Tags

  • 0.5.5                                ...           latest (3 months ago)

40 Versions

  • 0.5.5                                ...           3 months ago
  • 0.5.4                                ...           3 months ago
  • 0.5.3                                ...           4 months ago
  • 0.5.2                                ...           4 months ago
  • 0.5.1                                ...           4 months ago
  • 0.5.0                                ...           4 months ago
  • 0.4.2                                ...           4 months ago
  • 0.4.1                                ...           4 months ago
  • 0.4.0                                ...           4 months ago
  • 0.3.1                                ...           5 months ago
  • 0.3.0                                ...           5 months ago
  • 0.2.11                                ...           5 months ago
  • 0.2.10                                ...           5 months ago
  • 0.2.9                                ...           5 months ago
  • 0.2.8                                ...           5 months ago
  • 0.2.7                                ...           5 months ago
  • 0.2.6                                ...           5 months ago
  • 0.2.5                                ...           5 months ago
  • 0.2.4                                ...           5 months ago
  • 0.2.3                                ...           5 months ago
  • 0.2.2                                ...           5 months ago
  • 0.2.1                                ...           5 months ago
  • 0.2.0                                ...           5 months ago
  • 0.1.16                                ...           5 months ago
  • 0.1.15                                ...           5 months ago
  • 0.1.14                                ...           5 months ago
  • 0.1.13                                ...           5 months ago
  • 0.1.12                                ...           5 months ago
  • 0.1.11                                ...           5 months ago
  • 0.1.10                                ...           5 months ago
  • 0.1.9                                ...           5 months ago
  • 0.1.8                                ...           5 months ago
  • 0.1.7                                ...           5 months ago
  • 0.1.6                                ...           5 months ago
  • 0.1.5                                ...           5 months ago
  • 0.1.4                                ...           5 months ago
  • 0.1.3                                ...           5 months ago
  • 0.1.2                                ...           5 months ago
  • 0.1.1                                ...           5 months ago
  • 0.1.0                                ...           5 months ago
Maintainers (1)
Downloads
Today 0
This Week 41
This Month 41
Last Day 0
Last Week 82
Last Month 177
Dependencies (25)
Dev Dependencies (3)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |