Skip to content

Commit

Permalink
Merge pull request #9 from firezym/main
Browse files Browse the repository at this point in the history
Update documentation description
  • Loading branch information
parmentelat authored Dec 3, 2023
2 parents fed51cc + 8806b49 commit 3cca69b
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5 deletions.
Binary file added README-use-case.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
7 changes: 5 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ JupyterLab extension to
- tag cells so that they use a fraction of the width
- can replace former 'split-cell' extension in the classic notebook

![Use case gif demo](README-use-case.gif)

It was have preferred not to re-use the term 'split', because in jupyterlab _split_ already means, well, to split a cell into 2 cells...

## Requirements
Expand All @@ -17,9 +19,10 @@ It was have preferred not to re-use the term 'split', because in jupyterlab _spl

### as a replacement for for former `split-cell`

there is no button (yet) in this extension to do the equivalent of the former 'split-cell' thing, you can use
you can use

- either keyboard `Alt+1, Alt+2` (meaning you want to use 1 / 2 of the horizontal space)
- either press the `<->` button on the notebook toolbar and use the drop down list to perform cell width adjustment (shown in the demo gif above)
- or keyboard `Alt+1, Alt+2` (meaning you want to use 1 / 2 of the horizontal space)
- or type `gridwidth` in the Palette and pick 1/2
- or command `gridwidth:toggle-1-2`
- that you can bind to a keyboard shortcut of your choice
Expand Down
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "jupyterlab-gridwidth",
"version": "0.2.2",
"description": "Jlab extension for showing course levels and structure",
"description": "Jlab extension that adjusts cell width among full width, half width, 1/3, 2/3, etc. Gridwidth replaces former 'split-cell' extension in the classic notebook.",
"keywords": [
"jupyter",
"jupyterlab",
Expand Down
4 changes: 2 additions & 2 deletions schema/plugin.json
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
{
"title": "gridwidth",
"title": "Gridwidth (Toogle Cell Width)",
"description": "Settings for jupyterlab-gridwidth",
"properties": {
"show_toolbar_button": {
"type": "boolean",
"title": "display button in toolbar",
"description": "The <-> button in the notebook toolbar gives access to a dropdown that allows for quick access to all available cell sizes, in addition to the palette and keyboard shortcuts.",
"description": "The <-> button in the notebook toolbar gives access to a dropdown that allows for quick access to all available cell sizes, in addition to the palette and keyboard shortcuts. You can adjust cell width among full width, half width, 1/3, 2/3, etc.",
"default": true
}
},
Expand Down

0 comments on commit 3cca69b

Please sign in to comment.