release: v1.0.1

Author: plainheart

README.md

@@ -1,31 +1,99 @@
 # echarts-offline-doc-cli
+[![NPM version](https://img.shields.io/npm/v/echarts-offline-doc-cli.svg?style=flat)](https://www.npmjs.org/package/echarts-offline-doc-cli)
+[![Auto Deploy](https://github.com/plainheart/echarts-offline-doc-cli/actions/workflows/deploy.yaml/badge.svg)](https://github.com/plainheart/echarts-offline-doc-cli/actions/workflows/deploy.yaml)
+[![NPM Downloads](https://img.shields.io/npm/dm/echarts-offline-doc-cli.svg)](https://npmcharts.com/compare/echarts-offline-doc-cli?minimal=true)
+[![License](https://img.shields.io/npm/l/echarts-offline-doc-cli.svg)](https://github.com/plainheart/echarts-offline-doc-cli/blob/main/LICENSE)
+
 A CLI tool for offline documentation of Apache ECharts.
 
-# Build Steps
+[Preview on GitHub Pages](https://plainheart.github.io/echarts-offline-doc-cli)
+
+![Screenshot](https://user-images.githubusercontent.com/26999792/229869304-4a782121-4324-4e68-9f3d-a956d0c60ee6.png)
+
+# Get Started
+
+## Install Globally
+
+```sh
+npm i echarts-offline-doc-cli -g
+```
+
+### Build Offline Documentation
+
+```sh
+echarts-offline-doc --build
+# Equivalent to:
+echarts-offline-doc -b
+
+# If it's slow to clone the echarts-doc repo
+# you can specify a proxy URL
+echarts-offline-doc --build --proxy https://hub.fgit.gq/apache/echarts-doc
+# Equivalent to:
+echarts-offline-doc -b -p https://hub.fgit.gq/apache/echarts-doc
+
+# If it's slow to install dependencies
+# you can optionally use `cnpm`
+echarts-offline-doc --build --cnpm
+# Equivalent to:
+echarts-offline-doc -b -c
+
+# View Help
+echarts-offline-doc --help
+# Equivalent to:
+echarts-offline-doc -h
+```
+
+### View Offline Documentation With an HTTP Server
+
+```sh
+echarts-offline-doc
+# Equivalent to:
+echarts-offline-doc --serve
+# Equivalent to:
+echarts-offline-doc -s
+```
+
+### View Offline Documentation Locally
+
+```sh
+echarts-offline-doc --local
+# Equivalent to:
+echarts-offline-doc -l
+```
+
+## Build From Source
 
 ```sh
 # clone the repo
-git clone https://github.com/plainheart/echarts-offline-doc-cli.git --depth=1
+git clone https://github.com/plainheart/echarts-offline-doc-cli --depth=1
 
 # install dependencies
 npm i
 
 # build offline documentation
 npm run build
 
-# If it's slow to clone the echarts-doc repo or install dependencies
+# If it's slow to clone the echarts-doc repo
 # you can specify a proxy URL
-npm run build -- --proxy=https://hub.fgit.gq/apache/echarts-doc
+npm run build -- --proxy https://hub.fgit.gq/apache/echarts-doc
+# Equivalent to:
+npm run build -- -p https://hub.fgit.gq/apache/echarts-doc
 
 # If it's slow to install dependencies
 # you can optionally use `cnpm`
 npm run build -- --cnpm
+# Equivalent to:
+npm run build -- -c
 
-# start a local server to view the documentation offline
-npm run start:server
+# start an HTTP server to view the documentation offline
+npm start
+# Equivalent to:
+npm run serve
 
-# or run the following command to open the static pages without a server
-npm run start
+# or run the following command to open the static pages locally without a server
+npm run local
 ```
 
+## License
 
+MIT © 2021-2023 [plainheart](https://github.com/plainheart).

bin/echarts-offline-doc.js

@@ -1,23 +1,41 @@
 #!/usr/bin/env node
 
+'use strict'
+
 const program = require('commander')
-const { version } = require('../package.json')
+const { version, scripts } = require('../package.json')
 
 const config = require('../config')
 
 program
   .version(version, '-v, --version')
   .usage('[options]')
-  .option('-p, --proxy [url]', 'URL of the proxy repo')
-  .option('-c, --cnpm', 'Whether to use `cnpm` to install dependencies')
+  .option('-b, --build', 'build/rebuild the offline documentation')
+  .option('-p, --proxy [url]', 'URL of the proxy repo to be used when building the offline documentation')
+  .option('-c, --cnpm', 'whether to use `cnpm` to install dependencies when building the offline documentation')
+  .option('-s, --serve', 'start an HTTP server and open the default browser to view the documentation')
+  .option('-l, --local', 'open the static pages locally without a server')
   .parse(process.argv)
 
 const options = program.opts()
 
-if (options.proxy) {
-  config.DOC_REPO = options.proxy
+if (options.build) {
+  if (options.proxy) {
+    config.DOC_REPO = options.proxy
+  }
+
+  config.USE_CNPM = options.cnpm
+
+  require('..')()
+}
+else {
+  require('cross-spawn')
+    .spawn(scripts[options.local ? 'local' : 'serve'], {
+      cwd: require('node:path').resolve(__dirname, '../'),
+      stdio: 'inherit',
+      windowsHide: true,
+      detached: false
+    })
 }
 
-config.USE_CNPM = options.cnpm
 
-require('..')()