Blinks
Handy documentation app for blinkist products. Check example folder for advanced features.
Quick Start
Install blinks
globally via npm
npm install -g blinks
Then use cli
# will create docs folder if not exists with dummy README.me fileblinks init# serve docs folder with hot reload at localhost:8080blinks dev# build static docs siteblinks build
Local installation
# install blinkist-doc locallynpm install --save blinks
then add npm scripts into your package.json
Build Setup
# install dependenciesnpm install# serve with hot reload at localhost:8080cd example && ../bin/blinks# build for production releasenpm run build
TODO
- Unit tests
- Example running vue, js and css
- User config
- Move Example to optionated addons (reduce final file size)
- Templates (eg: https://github.com/material-components/material-components-web/blob/master/docs/code/readme_template.md)
Known Issues
Hot reload sometimes? stops reloading, dropping poi and using webpack directly can fix.
Built with poi
and vue
.