Skip to content

Commit

Permalink
add cli docs
Browse files Browse the repository at this point in the history
  • Loading branch information
bollwyvl committed May 9, 2021
1 parent 5c5e75c commit 66b0f95
Showing 1 changed file with 17 additions and 5 deletions.
22 changes: 17 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,12 +160,26 @@ if ( tour ) {
## Disabling the User and Default Tours

If you _only_ wish to see the default _Welcome_ and _Notebook_ tours, or ones
defined by users, create a [pageConfig.json] and put it in _the right place_, e.g.
defined by users, they can be disabled via the command line or a well-known file.

The examples below disable all tours not provided by third-party extensions.
Adding `jupyterlab-tour:plugin` to either of these will disable tours altogether!

### Disabling Tours from the Command Line

From the command line, run:

```bash
jupyter labextension disable "jupyterlab-tour:user-tours"
jupyter labextension disable "jupyterlab-tour:default-tours"
```

### Disabling Tours with `pageConfig.json`

Create a [pageConfig.json] and put it in _the right place_, e.g.
`{sys.prefix}/etc/jupyter/labconfig/pageconfig.json` and add the plugin IDs to
`disabledExtensions`.

For example, to disable all tours not provided by other extensions:

```json
{
"disabledExtensions": {
Expand All @@ -175,8 +189,6 @@ For example, to disable all tours not provided by other extensions:
}
```

Adding `"jupyterlab-tour:plugin": true` will disable _all_ tours!

[pageConfig.json]: https://jupyterlab.readthedocs.io/en/stable/user/directories.html#labconfig-directories


Expand Down

0 comments on commit 66b0f95

Please sign in to comment.