0.12.0 • Published 5 years ago
eze v0.12.0
EZE
Making creating meaninful demos / styleguides easy ❤️
Install
npm install eze -D
Create a ts (tsx) file (e.g. ./src/docs/main.ts
)
import { render } from "eze";
/** Render documentation */
render({
outputDir: __dirname + '/../../docs'
}, eze => {
/** Create a page */
eze.page({heading: 'Welcome', subDirName: 'welcome'})
/** Write some markdown */
.md(`
# Demo
This is the demo for eze
`)
/** Show some complete application demos */
.app({ entryPointPath: __dirname + '/app-1.tsx' });
});
Add a few npm scripts:
{
"scripts": {
"docs": "eze ./src/docs/main.ts",
"docs:live": "npm run docs -- --serve"
}
}
npm run docs
builds the demos out to the specified folder. HTML + JavaScript. You can push the outputdocs
folder to github, s3 or surge.sh or anywhere else you want 🌹.npm run docs:live
will build out the demos, serve the output folder (on port4000
or whatever is available in ascending order), and reload any connected browsers whenever the demo changes 🌹.
Documentation
0.12.0
5 years ago
0.11.3
5 years ago
0.11.2
5 years ago
0.11.1
5 years ago
0.11.0
5 years ago
0.10.10
6 years ago
0.10.9
6 years ago
0.10.8
6 years ago
0.10.7
6 years ago
0.10.6
6 years ago
0.10.5
6 years ago
0.10.4
6 years ago
0.10.3
6 years ago
0.10.2
6 years ago
0.10.1
6 years ago
0.10.0
6 years ago
0.9.2
7 years ago
0.9.1
7 years ago
0.9.0
7 years ago
0.8.1
7 years ago
0.8.0
7 years ago
0.7.0
7 years ago
0.6.0
7 years ago
0.5.0
7 years ago
0.4.0
7 years ago
0.3.0
7 years ago
0.2.3
7 years ago
0.2.2
7 years ago
0.2.1
7 years ago
0.2.0
7 years ago
0.1.8
7 years ago
0.1.7
7 years ago
0.1.6
7 years ago
0.1.5
7 years ago
0.1.4
7 years ago
0.1.3
7 years ago
0.1.1
7 years ago
0.1.0
7 years ago
0.0.0
7 years ago