@qneyraud/q-io v1.0.0

Library starter

npm library starter with documentation, example, linting and build ready

Usage

# clone repo
git clone git@github.com:quentinneyraud/library-starter.git __your_library_name__
cd __your_library_name__

# install dependencies
yarn

Replace all occurences of MYLIB in these files : package.json, rollup.config.js, docs/index.html, docs/README.md, example/index.html, example/index.js

Write your library

npm run dev

Write your library in src folder and test it with livereload on localhost:1234

Write documentation

npm run docs

Write documentation in docs folder and see it with livereload on localhost:3000

Build

npm run build

Publish on npm

1. Publish your own NPM package

npm version [patch | minor | major]
npm publish

Publish documentation

1. Set up GitHub Pages to use /docs folder

2. git push

Or use other Deploy

Other links

• Docsify
• Rollup
• Parcel