fix(all): update docs

snomiao · Jun 17, 2022 · 0c84651 · 0c84651
1 parent fcf0b6e
commit 0c84651
Show file tree

Hide file tree

Showing 24 changed files with 444 additions and 48 deletions.
diff --git a/ABOUT.md b/ABOUT.md
@@ -0,0 +1,20 @@
+# About
+
+## License
+
+GPLv3 - [The GNU General Public License v3.0 - GNU Project - Free Software Foundation](https://www.gnu.org/licenses/gpl-3.0.en.html)
+
+## Author
+
+Author: snomiao <snomiao@gmail.com>
+Website: [snomiao.com](https://snomiao.com)
+
+## Sponsors
+
+- None yet.
+
+Claim your sponsorship by donating snomiao <[Email: snomiao@gmail.com](mailto:snomiao@gmail.com)>
+
+## Contribute
+
+The main repo is in [here](https://github.com/snomiao/js#readme), any issue and PR's welcome.
diff --git a/README.md b/README.md
@@ -0,0 +1,42 @@
+# snomiao.js
+
+## Packages
+
+- [md-aggregate](./md-aggregate/README.md)
+- [monopkgs](./monopkgs/README.md)
+- [sno-utils](./sno-utils/README.md)
+- [objtranspose](./objtranspose/README.md)
+- [bothforage](./bothforage/README.md)
+- [my-version](./my-version/README.md)
+- [jsx-rename](./jsx-rename/README.md)
+- [snogwt](./snogwt/README.md)
+- [snorun](./snorun/README.md)
+- [snosay](./snosay/README.md)
+- [chrome-dev](./chrome-dev/README.md)
+- [chrome-extension-dev](./chrome-extension-dev/README.md)
+- [junction-move](./junction-move/README.md)
+- [snobuild](./snobuild/README.md)
+- [outer-join-by](./outer-join-by/README.md)
+- [snofa](./snofa/README.md)
+- [sno-mongo-ku](./sno-mongo-ku/README.md)
+
+## About
+
+### License
+
+GPLv3 - [The GNU General Public License v3.0 - GNU Project - Free Software Foundation](https://www.gnu.org/licenses/gpl-3.0.en.html)
+
+### Author
+
+Author: snomiao <snomiao@gmail.com>
+Website: [snomiao.com](https://snomiao.com)
+
+### Sponsors
+
+- None yet.
+
+Claim your sponsorship by donating snomiao <[Email: snomiao@gmail.com](mailto:snomiao@gmail.com)>
+
+### Contribute
+
+The main repo is in [here](https://github.com/snomiao/js#readme), any issue and PR's welcome.
diff --git a/package.json b/package.json
@@ -19,11 +19,14 @@
   ],
   "scripts": {
     "build": "lerna run build",
+    "docs": "npm run docs:root && npm run docs:about",
+    "docs:about": "lerna exec -- md-aggregate ./README.md -i ../../ABOUT.md -w",
+    "docs:root": "md-aggregate ./README.md -i ABOUT.md -w",
     "format": "prettier -w . && eslint --fix .",
     "lerna-publish": "lerna publish",
     "monopkgs": "monopkgs",
     "test": "lerna run test",
-    "postversion": "monopkgs && npm run format && git commit -a -m \"chore: bump version and format\""
+    "postversion": "npm run docs:root && monopkgs && npm run format && git commit -a -m \"chore: bump version and format\""
   },
   "devDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.19.0",

diff --git a/packages/bothforage/README.md b/packages/bothforage/README.md
@@ -1,4 +1,4 @@
-# README
+# bothForage is localForage + nodeForage
 
 a dead simple module trying to use localforage or nodeforage. - localforage in browser - nodeforage in Node.js
 
@@ -18,7 +18,6 @@ npm i bothforage
 
 GPLv3 - [The GNU General Public License v3.0 - GNU Project - Free Software Foundation](https://www.gnu.org/licenses/gpl-3.0.en.html)
 
-
 ### Author
 
 Author: snomiao <snomiao@gmail.com>

diff --git a/packages/chrome-dev/README.md b/packages/chrome-dev/README.md
@@ -37,7 +37,6 @@ chrome-dev -h
 
 GPLv3 - [The GNU General Public License v3.0 - GNU Project - Free Software Foundation](https://www.gnu.org/licenses/gpl-3.0.en.html)
 
-
 ### Author
 
 Author: snomiao <snomiao@gmail.com>

diff --git a/packages/chrome-extension-dev/README.md b/packages/chrome-extension-dev/README.md
@@ -24,7 +24,24 @@ extdev -v
 
 ```
 
-## Author & License
+
+## About
+
+### License
+
+GPLv3 - [The GNU General Public License v3.0 - GNU Project - Free Software Foundation](https://www.gnu.org/licenses/gpl-3.0.en.html)
+
+### Author
 
 Author: snomiao <snomiao@gmail.com>
-LICENSE: GPLv3
+Website: [snomiao.com](https://snomiao.com)
+
+### Sponsors
+
+- None yet.
+
+Claim your sponsorship by donating snomiao <[Email: snomiao@gmail.com](mailto:snomiao@gmail.com)>
+
+### Contribute
+
+The main repo is in [here](https://github.com/snomiao/js#readme), any issue and PR's welcome.
diff --git a/packages/jsx-rename/README.md b/packages/jsx-rename/README.md
@@ -1,21 +1,35 @@
 # JSX-Rename
 
-Rename your jsx files in .js into .jsx. Useful when you want to use vite.
+CLI tool to rename your jsx files in .js into .jsx. Useful when you want to migrate your project to vite.
 
 ## Usage
 
 ```shell
+npm i -g jsx-rename
+jsx-rename ./src/*.js
+```
 
-npx jsx-rename ./node-modules/**/react-native/*.js
-npx jsx-rename ./src/*.js
+## ref
 
-```
+- [jsx-renamer/jsx-renamer at master · PuddleByteComputing/jsx-renamer](https://github.com/PuddleByteComputing/jsx-renamer/blob/master/jsx-renamer)
+
+## About
+
+### License
 
-## Author & License
+GPLv3 - [The GNU General Public License v3.0 - GNU Project - Free Software Foundation](https://www.gnu.org/licenses/gpl-3.0.en.html)
+
+### Author
 
 Author: snomiao <snomiao@gmail.com>
-LICENSE: GPLv3
+Website: [snomiao.com](https://snomiao.com)
 
-## ref
+### Sponsors
 
-- [jsx-renamer/jsx-renamer at master · PuddleByteComputing/jsx-renamer](https://github.com/PuddleByteComputing/jsx-renamer/blob/master/jsx-renamer)
+- None yet.
+
+Claim your sponsorship by donating snomiao <[Email: snomiao@gmail.com](mailto:snomiao@gmail.com)>
+
+### Contribute
+
+The main repo is in [here](https://github.com/snomiao/js#readme), any issue and PR's welcome.
diff --git a/packages/junction-move/README.md b/packages/junction-move/README.md
@@ -1,10 +1,10 @@
 # junction-move
 
-Move a folder to new location and make a Juction link to new location. Only works with windows yet. 
+Move a folder to new location and make a Juction link to new location. Only works with windows yet.
 
 ## Usage
 
-```
+```batch
 Usage: npx junction-move from_folder to_folder
 Example: npx junction-move C:\Go D:\Go
 ```
@@ -17,7 +17,3 @@ With Two commands
 robocopy %from_path% %to_path% /MOVE /e
 mklink /J %from_path% %to_path%
 ```
-
-## License
-
-ISC
diff --git a/packages/md-aggregate/CHANGELOG.md b/packages/md-aggregate/CHANGELOG.md
@@ -99,3 +99,74 @@ Note: This section is orginally written in CHANGELOG.md file and is merged into
 ## 0.0.2 (2022-04-20)
 
 **Note:** Version bump only for package md-aggregate
+
+## MD-Aggregate
+
+Aggregate README.md with CHANGELOG.md or whatever.md.
+
+### Install
+
+```shell
+npm i -g md-aggregate
+```
+
+### Usage
+
+```plaintext
+md-aggregate <target> [input..]
+
+aggregate markdown files
+
+Options:
+  -w, --write    write mode (when missing you will get preview in console)
+                                                                     [boolean]  -i, --input    source markdown files                                 [array]  -t, --target   destination markdown file                            [string]  -h, --help     Show help                                           [boolean]  -v, --version  Show version number                                 [boolean]
+
+Examples:
+  preview:   md-aggregate README.md CHANGELOG.md
+  one:       md-aggregate README.md CHANGELOG.md -w
+  multi:     md-aggregate README.md ABOUT.md LICENSE.md CHANGELOG.md -w
+  multi:     md-aggregate README.md -i ABOUT.md -i LICENSE.md -i CHANGELOG.md
+             -w
+```
+
+### Description
+
+Insert markdown documents into one document, and level up the titles,
+
+For Example, you have README.md like this
+
+```markdown
+### README.md
+
+### OTHER
+
+...OTHER
+```
+
+and CHANGELOG.md like this
+
+```markdown
+### CHANGE LOG
+
+### x.x.x
+
+...CHANGELOG
+```
+
+It will be append or replaced into README.md like this:
+
+```markdown
+### README
+
+### OTHER
+
+...OTHER
+
+### CHANGE LOG
+
+#### x.x.x
+
+...CHANGELOG
+
+...
+```
diff --git a/packages/md-aggregate/README.md b/packages/md-aggregate/README.md
@@ -68,3 +68,24 @@ It will be append or replaced into README.md like this:
 
 ...
 ```
+
+## About
+
+### License
+
+GPLv3 - [The GNU General Public License v3.0 - GNU Project - Free Software Foundation](https://www.gnu.org/licenses/gpl-3.0.en.html)
+
+### Author
+
+Author: snomiao <snomiao@gmail.com>
+Website: [snomiao.com](https://snomiao.com)
+
+### Sponsors
+
+- None yet.
+
+Claim your sponsorship by donating snomiao <[Email: snomiao@gmail.com](mailto:snomiao@gmail.com)>
+
+### Contribute
+
+The main repo is in [here](https://github.com/snomiao/js#readme), any issue and PR's welcome.
diff --git a/packages/md-aggregate/package.json b/packages/md-aggregate/package.json
@@ -1,6 +1,6 @@
 {
   "name": "md-aggregate",
-  "version": "1.1.13",
+  "version": "2.0.1",
   "description": "Aggregate README.md with CHANGELOG.md or whatever",
   "keywords": [
     "markdown",
@@ -35,16 +35,16 @@
     "lib"
   ],
   "scripts": {
-    "build": "tsc && node esbuild-with-cli.mjs",
-    "prepack": "snobuild --lib",
+    "build": "snobuild --lib",
+    "prepack": "npm run build",
     "postversion": "prettier -w CHANGELOG.md && md-aggregate CHANGELOG.md README.md -w"
   },
   "dependencies": {
     "escape-string-regexp": "^5.0.0",
     "yargs": "^17.5.1"
   },
   "devDependencies": {
-    "snobuild": "^1.0.0"
+    "snobuild": "^2.0.0"
   },
   "publishConfig": {
     "access": "public"

diff --git a/packages/md-aggregate/src/cli.ts b/packages/md-aggregate/src/cli.ts
@@ -21,6 +21,5 @@ const argv = await yargs(hideBin(process.argv))
   .alias("h", "help")
   .alias("v", "version")
   .demandCommand(2).argv;
-console.log(argv);
 
 await mdAggregate( argv);
diff --git a/packages/monopkgs/README.md b/packages/monopkgs/README.md
@@ -27,13 +27,28 @@ cd $monorepo && npx monopkgs
   - [ ] overwrite or keep existed files
 - [x] respect .gitignores
 
-## PR's welcome.
+## Reference
 
-## Author
+- [node.js - Configure repository field on package.json on monorepo - Stack Overflow](https://stackoverflow.com/questions/52922529/configure-repository-field-on-package-json-on-monorepo)
 
-Author: snomiao@gmail.com
-LICENSE: GPLv3
+## About
 
-## Reference
+### License
 
-- [node.js - Configure repository field on package.json on monorepo - Stack Overflow](https://stackoverflow.com/questions/52922529/configure-repository-field-on-package-json-on-monorepo)
+GPLv3 - [The GNU General Public License v3.0 - GNU Project - Free Software Foundation](https://www.gnu.org/licenses/gpl-3.0.en.html)
+
+
+### Author
+
+Author: snomiao <snomiao@gmail.com>
+Website: [snomiao.com](https://snomiao.com)
+
+### Sponsors
+
+- None yet.
+
+Claim your sponsorship by donating snomiao <[Email: snomiao@gmail.com](mailto:snomiao@gmail.com)>
+
+### Contribute
+
+The main repo is in [here](https://github.com/snomiao/js#readme), any issue and PR's welcome.
diff --git a/packages/my-version/README.md b/packages/my-version/README.md
@@ -26,3 +26,24 @@ if (args["--version"]) console.log(`v${await myVersion()}`)
 ## Reference
 
 - [pkg-dir - npm](https://www.npmjs.com/package/pkg-dir)
+
+## About
+
+### License
+
+GPLv3 - [The GNU General Public License v3.0 - GNU Project - Free Software Foundation](https://www.gnu.org/licenses/gpl-3.0.en.html)
+
+### Author
+
+Author: snomiao <snomiao@gmail.com>
+Website: [snomiao.com](https://snomiao.com)
+
+### Sponsors
+
+- None yet.
+
+Claim your sponsorship by donating snomiao <[Email: snomiao@gmail.com](mailto:snomiao@gmail.com)>
+
+### Contribute
+
+The main repo is in [here](https://github.com/snomiao/js#readme), any issue and PR's welcome.