@@ -21,6 +21,29 @@ This should automatically enable the extension. If it is not listed in `jupyter
2121 jupyter serverextension enable --py jupyter_offlinenotebook --sys-prefix
2222
2323
24+ Usage
25+ -----
26+
27+ ![ Offline notebook buttons] ( ./offline-notebook-buttons.png )
28+
29+ You should see up to five new buttons depending on your configuration and where you are running the notebook:
30+ - download the in-memory (browser) state of the notebook
31+ - save the in-memory state of the notebook to local-storage
32+ - load a notebook from local-storage
33+ - open the permanent URL of the repository containing this notebook
34+ - copy the permanent mybinder URL to share this repository
35+
36+ Saving and loading uses the repository ID and the path of the current notebook.
37+
38+ You should always see the ` Download ` button.
39+ If you are running this on mybinder all buttons should be visible.
40+ See the configuration section below to enable the other buttons on other systems.
41+
42+ If you don't see the buttons check the Javascript console log.
43+
44+ See [ example.ipynb] ( ./example.ipynb )
45+
46+
2447Configuration
2548-------------
2649
@@ -36,23 +59,8 @@ This extension can be configured in `jupyter_notebook_config.py` by setting the
3659 A callable that returns the repository reference URL.
3760 Default is the values of the ` BINDER_LAUNCH_HOST ` and
3861 ` BINDER_PERSISTENT_REQUEST ` environment variables.
39-
40-
41-
42- Usage
43- -----
44-
45- ![ Offline notebook buttons] ( ./offline-notebook-buttons.png )
46-
47- There are three new icons to:
48- - download the in-memory (browser) state of the notebook
49- - save the in-memory state of the notebook to local-storage
50- - load a notebook from local-storage
51-
52- Saving and loading uses the repository ID and the path of the current notebook.
53- If you don't see the buttons check the Javascritp console log, it may mean no repository ID was found.
54-
55- See [ example.ipynb] ( ./example.ipynb )
62+ - ` binder_repo_label ` :
63+ A callable that returns the label used to link to the repository.
5664
5765
5866** WARNING**
0 commit comments