blinks v0.0.1

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 file
blinks init

# serve docs folder with hot reload at localhost:8080
blinks dev

# build static docs site
blinks build

Local installation

# install blinkist-doc locally
npm install --save blinks

then add npm scripts into your package.json

{
  "scripts": {
    "docs:init": "blinks init",
    "docs:dev": "blinks dev",
    "docs:build": "blinks build"
  }
}

Build Setup

# install dependencies
npm install

# serve with hot reload at localhost:8080
cd example && ../bin/blinks

# build for production release
npm 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.