diff --git a/docs/reference/index.md b/docs/reference/index.md index 6fe0efd9..0de64d5f 100644 --- a/docs/reference/index.md +++ b/docs/reference/index.md @@ -17,6 +17,16 @@ caption: Modules --- modules/* ``` + +```{toctree} +--- +maxdepth: 1 +glob: +caption: Plugins +--- +plugins/* +``` + ```{toctree} --- maxdepth: 1 diff --git a/docs/reference/plugins/py-terminal.md b/docs/reference/plugins/py-terminal.md new file mode 100644 index 00000000..0bea2d3d --- /dev/null +++ b/docs/reference/plugins/py-terminal.md @@ -0,0 +1,41 @@ +# <py-terminal> + +This is one of the core plugins in PyScript, which is active by default. With it, you can print to `stdout` and `stderr` from your python code, and the output will be displayed on the page in ``. + +## Configuration + +You can control how `` behaves by setting the value of the `terminal` configuration in your ``. + +| value | description | +|-------|-------------| +| `false` | Don't add `` to the page | +| `true` | Automatically add a `` to the page | +| `"auto"` | This is the default. Automatically add a ``, to the page. The terminal is initially hidden and automatically shown as soon as something writes to `stdout` and/or `stderr` | + +### Examples + +```html + + terminal = true + + + + print("Hello, world!") + +``` + +This example will create a new ``, the value "Hello, world!" that was printed will show in it. + +You can also add one (or more) `` to the page manually. + +```html + + print("Hello, world!") + + + +``` + +```{note} +If you include a `` in the page, you can skip `terminal` from your ``. +```