Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Document default_settings for jupyterlab #407

Merged
merged 3 commits into from
Feb 19, 2024
Merged

Document default_settings for jupyterlab #407

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f2f4d35
Document `default_settings` for jupyterlab
krassowski Feb 15, 2024
2a9e4e3
Adjust wording of introductory sentence
krassowski Feb 15, 2024
9267c06
Merge branch 'main' into document_default_settings
aktech Feb 19, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 11 additions & 1 deletion docs/docs/explanations/advanced-custom-settings.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@ jupyterhub:

### JupyterLab

Nebari supports two main configuration options for JupyterLab:
Nebari supports a number of configuration options for JupyterLab:

- `jupyterlab.idle_culler` - This is used to configure the idle culler for JupyterLab. See [idle culling](/docs/how-tos/idle-culling) for more information.

Expand All @@ -138,6 +138,16 @@ Currently only public git repositories are supported. Path location key should n
You can configure JupyterLab to open in a location within the cloned repository by setting `preferred_dir` option within the `jupyterlab` group.
:::


- `jupyterlab.default_settings` - Enables overriding the default JupyterLab and JupyterLab extensions settings. Users will still be able to adjust the settings in the JupyterLab Setting Editor. The keys should be names of the Jupyter plugins with values defining mapping between the plugin setting and new default.

```yaml
jupyterlab:
default_settings:
"@jupyterlab/apputils-extension:themes":
theme: JupyterLab Dark
```

- `jupyterlab.preferred_dir` - Sets the default location in which JupyterLab should open the file browser in.

### Terraform
Expand Down
Loading