Merge pull request #884 from thewtex/packages-docs

Packages docs
InsightSoftwareConsortium · Aug 7, 2023 · 09765c4 · 09765c4
2 parents 68ed164 + fe26b2e
commit 09765c4
Show file tree

Hide file tree

Showing 10 changed files with 52 additions and 6 deletions.
diff --git a/docs/assets/javascript-logo.svg b/docs/assets/javascript-logo.svg
diff --git a/docs/assets/typescript-logo.svg b/docs/assets/typescript-logo.svg
diff --git a/docs/docs/_sidebar.md b/docs/docs/_sidebar.md
@@ -2,6 +2,8 @@
 
   - [Installation](/docs/installation)
 
+  - [Packages](/docs/packages)
+
   - [IO formats](/docs/file_formats)
 
     - [DICOM](/docs/dicom_formats)

diff --git a/docs/docs/installation.md b/docs/docs/installation.md
@@ -3,9 +3,8 @@
 Install with:
 
 ```sh
-npm install --save itk-wasm
+npm install -g itk-wasm
 ```
 
-For more information on build configuration, see how to use *itk-wasm* [in a
-Node.js server application](/examples/node_io) or in an application that
-[targets the web browser with Webpack](/examples/webpack).
+For more information on installation setup, see [the tutorial
+Introduction](../tutorial/hello_world?id=introduction).
diff --git a/docs/docs/packages.md b/docs/docs/packages.md
@@ -0,0 +1,21 @@
+# Packages
+
+Example packages built with itk-wasm can be found below. If you created a
+package, please [open a pull
+request](https://github.com/InsightSoftwareConsortium/itk-wasm/compare) to add it to the table!
+
+| <img width=100/> Repository | <img width=250/> Description | <img width=200/> Links |
+|-----------------------------|------------------------------|:----------------------:|
+| [@itk-wasm/compress-stringify][compress-stringify-repo] | *Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.* | ![js][js-logo] ![ts][ts-logo] <br/>[💻][compress-stringify-demo-js] &nbsp;[🕮][compress-stringify-docs-js] &nbsp;[📦][compress-stringify-package-js] <br/> <br/> ![py][py-logo] <br/>[💻][compress-stringify-demo-py] &nbsp;[🕮][compress-stringify-docs-py] &nbsp;[📦][compress-stringify-package-py] |
+
+[js-logo]: ../assets/javascript-logo.svg
+[ts-logo]: ../assets/typescript-logo.svg
+[py-logo]: ../assets/python.svg
+
+[compress-stringify-repo]: https://github.com/InsightSoftwareConsortium/itk-wasm/tree/main/packages/compress-stringify
+[compress-stringify-demo-js]: https://itk-compress-stringify-app.on.fleek.co/
+[compress-stringify-docs-js]: https://itk-compress-stringify-docs.on.fleek.co/
+[compress-stringify-package-js]: https://www.npmjs.com/package/@itk-wasm/compress-stringify
+[compress-stringify-demo-py]: https://itk-compress-stringify-py-app.on.fleek.co/
+[compress-stringify-docs-py]: https://itk-wasm-compress-stringify-python-docs.on.fleek.co/
+[compress-stringify-package-py]: https://pypi.org/project/itkwasm-compress-stringify/
diff --git a/docs/index.html b/docs/index.html
@@ -53,6 +53,7 @@
       coverpage: true,
       loadSidebar: true,
       loadNavbar: false,
+      nativeEmoji: true,
       maxLevel: 3,
       subMaxLevel: 2,
       pagination: {

diff --git a/packages/compress-stringify/python/itkwasm-compress-stringify/README.md b/packages/compress-stringify/python/itkwasm-compress-stringify/README.md
@@ -4,6 +4,10 @@
 
 Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.
 
+[**Example**](https://itk-compress-stringify-py-app.on.fleek.co/)
+
+[**Documentation**](https://itk-wasm-compress-stringify-python-docs.on.fleek.co/)
+
 ## Installation
 
 ```sh

diff --git a/packages/compress-stringify/python/itkwasm-compress-stringify/docs/index.md b/packages/compress-stringify/python/itkwasm-compress-stringify/docs/index.md
@@ -5,6 +5,8 @@ itkwasm-compress-stringify
 
 [![itkwasm-compress-stringify version](https://badge.fury.io/py/itkwasm_compress_stringify.svg)](https://pypi.org/project/itkwasm_compress_stringify/)
 
+[**Example**](https://itk-compress-stringify-py-app.on.fleek.co/)
+
 ## Installation
 
 ::::{tab-set}
@@ -32,4 +34,4 @@ await micropip.install('itkwasm-compress-stringify')
 
 apidocs/index.rst
 itkwasm docs <https://itkwasm.readthedocs.io/>
-```
+```
diff --git a/packages/core/python/itkwasm/docs/index.md b/packages/core/python/itkwasm/docs/index.md
@@ -32,6 +32,7 @@ This site provides the Python documentation. There is also [C++ and JavaScript/T
 ```{toctree}
 :hidden:
 introduction.md
+packages.md
 numpy.md
 itk_python.md
 ```
@@ -43,4 +44,4 @@ itk_python.md
 
 apidocs/index.rst
 C++/JavaScript Docs <https://wasm.itk.org/>
-```
+```
diff --git a/packages/core/python/itkwasm/docs/packages.md b/packages/core/python/itkwasm/docs/packages.md
@@ -0,0 +1,14 @@
+# Packages
+
+Example packages built with itk-wasm can be found below. If you created a
+package, please [open a pull
+request](https://github.com/InsightSoftwareConsortium/itk-wasm/compare) to add it to the table!
+
+| <img width=200/> Repository |  Description                 | <img width=200/> Links |
+|-----------------------------|------------------------------|:----------------------:|
+| [itkwasm-compress-stringify][compress-stringify-repo] | *Zstandard compression and decompression and base64 encoding and decoding in WebAssembly.* | [💻][compress-stringify-demo-py] &nbsp;[🕮][compress-stringify-docs-py] &nbsp;[📦][compress-stringify-package-py] |
+
+[compress-stringify-repo]: https://github.com/InsightSoftwareConsortium/itk-wasm/tree/main/packages/compress-stringify
+[compress-stringify-demo-py]: https://itk-compress-stringify-py-app.on.fleek.co/
+[compress-stringify-docs-py]: https://itk-wasm-compress-stringify-python-docs.on.fleek.co/
+[compress-stringify-package-py]: https://pypi.org/project/itkwasm-compress-stringify/