diff --git a/README.md b/README.md index 647be1b..acf684b 100644 --- a/README.md +++ b/README.md @@ -60,24 +60,21 @@ qnorr ships with two dependencies by default: - We use [gulp@4.0^](https://gulpjs.com/) to build the library (legacy CLI scripts are also available but they are way difficult to maintain). - We use [parcel](https://parceljs.org/) and [posthtml plugins](https://github.com/posthtml/posthtml) to build a basic site located under `/site` folder. If you want to help build a real documentation site, create a `docs` folder and let's use the monorepo approach — docs building are separated from library and we can use any tool to make it happen (vuepress, gitbook, etc.), suggestions are welcomed. -Building +Developing ``` # watch mode for qnorr, dev server for demo site yarn run start - -# production build (lib and site) -yarn run build:all ``` -Developing qnorr only +Production build ``` -yarn run dev:qnorr -yarn run build:qnorr +# optimized output for publishing +yarn run qnorr:build ``` -Developing playground site +Play at playground site ``` -yarn run dev:playground +yarn run playground:dev ``` ## License diff --git a/package.json b/package.json index a99bfa0..7e2445d 100644 --- a/package.json +++ b/package.json @@ -22,18 +22,12 @@ "scss/**/*.scss" ], "scripts": { - "dev": "node-sass -w --output-style expanded --source-map true --source-map-contents true --precision 6 scss/qnorr.scss dist/qnorr.css", - "build": "yarn run clean:dist && yarn run preprocess && yarn run postprocess", - "clean:dist": "rm -rf dist/*", - "preprocess": "node-sass --output-style expanded --source-map true --source-map-contents true --precision 6 scss/qnorr.scss dist/qnorr.css", - "postprocess": "postcss 'dist/*.css' --replace && postcss 'dist/*.css' --o 'dist/qnorr.min.css' --env=production", - "dev:qnorr": "gulp dev", - "build:qnorr": "gulp", - "dev:playground": "rm -rf public/** && parcel site/index.html --out-dir public", - "build:playground": "rm -rf public/** && parcel build site/index.html --out-dir public --public-url ./", - "deploy:docs": "yarn run build:qnorr && node deploy.js", - "start": "yarn run dev:qnorr", - "build:all": "yarn run build:site && yarn run build:qnorr" + "qnorr:dev": "gulp dev", + "qnorr:build": "gulp", + "start": "yarn run qnorr:dev", + "docs:deploy": "yarn run build:qnorr && node deploy.js", + "playground:dev": "rm -rf public/** && parcel site/index.html --out-dir public", + "playground:build": "rm -rf public/** && parcel build site/index.html --out-dir public --public-url ./" }, "devDependencies": { "@babel/core": "^7.2.2",