From 8e67775b4d4e63d40076295126b61c79421dde78 Mon Sep 17 00:00:00 2001 From: linchen1987 Date: Fri, 11 Nov 2022 14:17:48 +0800 Subject: [PATCH 1/2] doc: polish blocklet cli doc --- CHANGELOG.md | 4 + developer/docs/blocklet.yml | 2 +- .../pages/reference/blocklet-cli/index.md | 61 +++++--- .../pages/reference/blocklet-cli/index.zh.md | 135 ++++++++++-------- developer/pages/blocklet.yml | 2 +- version | 2 +- website/docs/blocklet.yml | 2 +- website/pages/blocklet.yml | 2 +- 8 files changed, 122 insertions(+), 88 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 51a2259..0b35825 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,3 +1,7 @@ +## 0.1.100 (November 11, 2022) + +- docs: polish blocklet cli + ## 0.1.99 (November 07, 2022) - feat: added FAQ for storage chapter diff --git a/developer/docs/blocklet.yml b/developer/docs/blocklet.yml index aca5801..75c6414 100644 --- a/developer/docs/blocklet.yml +++ b/developer/docs/blocklet.yml @@ -14,7 +14,7 @@ repository: type: git url: git+https://github.com/blocklet/blocklet-site.git specVersion: 1.2.7 -version: 0.1.99 +version: 0.1.100 logo: logo.png files: - hooks/post-start.js diff --git a/developer/docs/pages/reference/blocklet-cli/index.md b/developer/docs/pages/reference/blocklet-cli/index.md index 81d6534..f08ef49 100644 --- a/developer/docs/pages/reference/blocklet-cli/index.md +++ b/developer/docs/pages/reference/blocklet-cli/index.md @@ -7,7 +7,7 @@ layout: documentation Blocklet CLI provides `blocklet` command-line tool for controlling and administering Blocklets. Use the following syntax to run `blocklet` commands from your terminal: ```bash -blocklet [options] [command] +$ blocklet [options] [command] ``` You can use the `-h` or `--help` to determine the full list of supported commands. @@ -36,19 +36,34 @@ $ blocklet create Develop blocklet from current directory ```bash -blocklet dev +$ blocklet dev + +ℹ Try to dev blocklet from xxxxxxxx + +ℹ Node DID from config xxxxxx +ℹ Node config from xxxxxx +✔ Installing blocklet-developer-docs@0.1.0... Done in 0.31s +✔ Blocklet blocklet-developer-docs@0.1.0 was successfully installed + +... + +✔ Blocklet blocklet-developer-docs@0.1.0 was successfully started + +ℹ You can access with the following URL + +- http://xxxxxx-xxxxxxxxxxxxxxxxxxxx.did.abtnet.io ``` Open the browser after blocklet had been started ```bash -blocklet dev --open +$ blocklet dev --open ``` Develop blocklet as a component ```bash -blocklet dev --app-id --mount-point /xxx +$ blocklet dev --app-id --mount-point /xxx ``` - `blocklet-app-id` can be viewed in the blocklet details page @@ -59,7 +74,7 @@ blocklet dev --app-id --mount-point /xxx Execute script in blocklet running context ```bash -blocklet exec