Skip to content

Commit 49791bf

Browse files
Add docs on global button text and overrides
1 parent 1ee4ea7 commit 49791bf

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/configuration.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -67,6 +67,23 @@ jupyterlite_config = "jupyter_lite_config.json"
6767
jupyterlite_overrides = "overrides.json"
6868
```
6969

70+
# Setting default button texts for the `JupyterLite`, `NotebookLite`, and `Voici` directives
71+
72+
When using the `:new_tab:` option in the `JupyterLite`, `NotebookLite`, and `Voici` directives,
73+
the button text defaults to "Open as a notebook" and "Open with Voici", respectively.
74+
75+
You can optionally the button text on a global level for these directives by setting the
76+
following values in your `conf.py` file:
77+
78+
```python
79+
jupyterlite_button_text = "My custom JupyterLite button text"
80+
notebooklite_button_text = "My custom NotebookLite button text"
81+
voici_button_text = "My custom Voici button text"
82+
```
83+
84+
You can override this text on a per-directive basis by passing the `:button_text:` option
85+
to the directive. Note that this is compatible only if `:new_tab:` is also provided.
86+
7087
## Strip particular tagged cells from IPython Notebooks
7188

7289
When using the `NotebookLite`, `JupyterLite`, or `Voici` directives with a notebook passed to them, you can

0 commit comments

Comments
 (0)