docs: 📝 Add jsdoc.io documentation badges

xeho91 · xeho91 · commit b1dc871b4194 · 2023-03-14T15:01:59.000+08:00
diff --git a/packages/error/README.md b/packages/error/README.md
@@ -17,6 +17,11 @@
 
 ## Modules included
 
+[![documentation badge]][documentation url]
+
+[documentation badge]: https://img.shields.io/static/v1?color=informational&style=for-the-badge&label=documentation&message=jsdocs.io
+[documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets-error
+
 <!-- prettier-sort-markdown-table -->
 
 | Name                                        | Size                                                      |
diff --git a/packages/regexp/README.md b/packages/regexp/README.md
@@ -17,6 +17,11 @@
 
 ## Modules included
 
+[![documentation badge]][documentation url]
+
+[documentation badge]: https://img.shields.io/static/v1?color=informational&style=for-the-badge&label=documentation&message=jsdocs.io
+[documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets-regexp
+
 <!-- prettier-sort-markdown-table -->
 
 | Name                                        | Size                                                    |
diff --git a/packages/runtime/README.md b/packages/runtime/README.md
@@ -12,6 +12,11 @@
 
 ## Modules included
 
+[![documentation badge]][documentation url]
+
+[documentation badge]: https://img.shields.io/static/v1?color=informational&style=for-the-badge&label=documentation&message=jsdocs.io
+[documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets-runtime
+
 | Name                                             | Size                                                            |
 | ------------------------------------------------ | --------------------------------------------------------------- |
 | [`@terminal-nerds/snippets-runtime/environment`] | ![environment size gzip badge] ![environment size brotli badge] |
diff --git a/packages/snippets/README.md b/packages/snippets/README.md
@@ -15,6 +15,11 @@
 
 ## Packages included
 
+[![documentation badge]][documentation url]
+
+[documentation badge]: https://img.shields.io/static/v1?color=informational&style=for-the-badge&label=documentation&message=jsdocs.io
+[documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets
+
 | Name                        | Version                                      |
 | --------------------------- | -------------------------------------------- |
 | [![error badge]][error]     | [![error version badge]][error npm page]     |
diff --git a/packages/string/README.md b/packages/string/README.md
@@ -17,6 +17,11 @@
 
 ## Modules included
 
+[![documentation badge]][documentation url]
+
+[documentation badge]: https://img.shields.io/static/v1?color=informational&style=for-the-badge&label=documentation&message=jsdocs.io
+[documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets-string
+
 <!-- prettier-sort-markdown-table -->
 
 | Name                                       | Size                                                  |
diff --git a/packages/test/README.md b/packages/test/README.md
@@ -12,6 +12,11 @@
 
 ## Modules included
 
+[![documentation badge]][documentation url]
+
+[documentation badge]: https://img.shields.io/static/v1?color=informational&style=for-the-badge&label=documentation&message=jsdocs.io
+[documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets-test
+
 | Name                                   | Size                                              |
 | -------------------------------------- | ------------------------------------------------- |
 | [`@terminal-nerds/snippets-test/unit`] | ![unit size gzip badge] ![unit size brotli badge] |
diff --git a/packages/type/README.md b/packages/type/README.md
@@ -16,6 +16,11 @@
 
 ## Modules included
 
+[![documentation badge]][documentation url]
+
+[documentation badge]: https://img.shields.io/static/v1?color=informational&style=for-the-badge&label=documentation&message=jsdocs.io
+[documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets-type
+
 <!-- prettier-sort-markdown-table -->
 
 | Name                                            | Size                                                                |
diff --git a/scripts/generate/source/generators/package/templates/package/README.md.hbs b/scripts/generate/source/generators/package/templates/package/README.md.hbs
@@ -16,6 +16,11 @@
 
 ## Modules included
 
+[![documentation badge]][documentation url]
+
+[documentation badge]: https://img.shields.io/static/v1?color=informational&style=for-the-badge&label=documentation&message=jsdocs.io
+[documentation url]: https://jsdocs.io/package/@terminal-nerds/snippets-{{ kebabCase name }}
+
 <!-- prettier-sort-markdown-table -->
 
 | Name | Size |
