Skip to content

Commit

Permalink
docs(python): Start packages table with compress-stringify
Browse files Browse the repository at this point in the history
  • Loading branch information
thewtex committed Aug 6, 2023
1 parent ce4be88 commit 0771e91
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 2 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -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}
Expand Down Expand Up @@ -32,4 +34,4 @@ await micropip.install('itkwasm-compress-stringify')

apidocs/index.rst
itkwasm docs <https://itkwasm.readthedocs.io/>
```
```
3 changes: 2 additions & 1 deletion packages/core/python/itkwasm/docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```
Expand All @@ -43,4 +44,4 @@ itk_python.md
apidocs/index.rst
C++/JavaScript Docs <https://wasm.itk.org/>
```
```
14 changes: 14 additions & 0 deletions packages/core/python/itkwasm/docs/packages.md
Original file line number Diff line number Diff line change
@@ -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/> Package | 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/

0 comments on commit 0771e91

Please sign in to comment.