npm library starter with documentation, example, linting and build ready
# clone repo
git clone git@github.com:quentinneyraud/library-starter.git __your_library_name__
cd __your_library_name__
# install dependencies
yarn
- Open
tasks/init.js
- Update these constants (
LIBRARY_TITLE
,LIBRARY_DESCRIPTION
,LIBRARY_NAME
,LIBRARY_DOC_URL
,LIBRARY_REPO_URL
) with yours - Run
npm init
It will update these files : package.json
, rollup.config.js
, docs/index.html
, docs/README.md
, example/index.html
, example/index.js
npm run dev
Write your library in src
folder and test it with livereload on localhost:1234
npm run docs
Write documentation in docs
folder and see it with livereload on localhost:3000
npm run build
npm version [patch | minor | major]
npm publish
-
Set up GitHub Pages to use
/docs
folder -
git push
Or use other Deploy