blinks
Documentation site generator for Blinkist products
Last updated 2 years ago by blinkster .
MIT · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install blinks 
SYNC missed versions from official npm registry.

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

Known Issues

Hot reload sometimes? stops reloading, dropping poi and using webpack directly can fix.


Built with poi and vue.

Current Tags

  • 0.0.1                                ...           latest (2 years ago)

1 Versions

  • 0.0.1                                ...           2 years ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 1
Last Day 0
Last Week 1
Last Month 4
Dependencies (6)
Dev Dependencies (2)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |