Skip to content

Commit bc87bf3

Browse files
committed
Update features section in documentation 2.0
1 parent 68c1914 commit bc87bf3

File tree

4 files changed

+23
-10
lines changed

4 files changed

+23
-10
lines changed
File renamed without changes.
File renamed without changes.
File renamed without changes.

docs/user/features.rst

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -6,30 +6,37 @@ Code Snippet Explorer
66

77
On the left side bar of the JupyterLab, you can click the snippet icon (</>) to open/close the code snippet explorer that contains all the saved snippets as below.
88
You can scroll/resize code snippet explorer, order the snippets with drag and drop, and manage and search the snippets efficiently.
9-
.. image:: ../../Design/Code Snippet Extension Panel.png
9+
10+
.. image:: ../../Design/CodeSnippetExtensionPanel.png
1011
:align: center
1112

1213
Creation of a New Snippet
1314
-------------------------
1415

1516
There are several ways to create a new snippet.
1617
1. Highlight lines of code and right click (or use keyboard shortcut (cmd-shift-A or ctrl-shift-A)) to save the code as a snippet. Or, you can select cell(s) and right click (or use keyboard shortcut (cmd-shift-A or ctrl-shift-A)) to save content as a snippet. Then, you will see the "Save As Code Snippet" option in JupyterLab context menu as below:
17-
.. image:: ../../Design/right_click.png
18-
:align: center
19-
Then, clicking the option will open the dialog as below where you can input name, description, language, tags, and codes of a snippet.
20-
.. image:: ../../Design/code_snippet_input_dialog.png
21-
:align:center
18+
19+
.. image:: ../../Design/right_click.png
20+
:align: center
21+
22+
Then, clicking the option will open the dialog as below where you can input name, description, language, tags, and codes of a snippet.
23+
24+
.. image:: ../../Design/code_snippet_input_dialog.png
25+
:align:center
26+
2227
2. More easily, just drag notebook cell(s) to the code snippet explorer on the left to create a new snippet. It will also open the dialog as above for your inputs.
23-
.. image:: ../../Design/create_from_scratch.png
24-
:align:center
28+
29+
.. image:: ../../Design/create_from_scratch.png
30+
:align:center
2531

2632
3. Hit the plus button next to the search bar (refer to `Search of Code Snippets`_) to create a new snippet if you want to create a snippet not from the notebook cell.
2733

2834
Use of Code Snippets
2935
--------------------
3036

3137
Click the three dots or right click anywhere on the snippet you want to use. It will open code snippet menu as below to insert, copy, edit, download, or delete the snippet.
32-
.. image:: ../../Design/Code Snippet Menu.png
38+
39+
.. image:: ../../Design/CodeSnippetMenu.png
3340
:align:center
3441

3542
Insert
@@ -40,34 +47,40 @@ Additionally, on hover with six dots on the left (refer to `Search of Code Snipp
4047
Copy
4148
^^^^
4249
Click the copy option to copy. It will create a message on the bottom right corner as below.
50+
4351
.. image:: ../../Design/copy_snippet.png
4452
:align:center
4553

4654
Edit
4755
^^^^
4856
Edit the saved snippets by clicking the edit option. It will open a code snippet editor as below.
57+
4958
.. image:: ../../Design/code_snippet_edit.png
5059
:align:center
5160

5261
Download
5362
^^^^^^^^
5463
Download snippets and share them with others by clicking the download option. It will open a box as below to input **relative path** to download the snippets.
64+
5565
.. image:: ../../Design/download_snippets_box.png
5666
:align:center
5767

5868
Delete
5969
^^^^^^
6070
Delete snippets by clicking delete option. It will open a warning box as below.
61-
.. image:: ../../Design/delete snippet.png
71+
72+
.. image:: ../../Design/delete_snippet.png
6273
:align:center
6374

6475
Search of Code Snippets
6576
-----------------------
6677

6778
With the filter box as below, **search** snippets with name, language, and code with search bar or **filter** them with language/filter tags!
79+
6880
.. image:: ../../Design/code_snippet_filter_box.png
6981
:align:center
7082

7183
Furthermore, hover over snippets to see the preview of each snippet.
84+
7285
.. image:: ../../Design/code_snippet_preview.png
7386
:align:center

0 commit comments

Comments
 (0)