Skip to content

Commit c05bced

Browse files
committed
Update documentation
1 parent 235ae6e commit c05bced

File tree

8 files changed

+17
-1
lines changed

8 files changed

+17
-1
lines changed

Design/add_custom_snippet.png

56 KB
Loading

Design/add_snippet.png

43.6 KB
Loading

Design/codeSnippetEditor.png

75.7 KB
Loading

Design/options.png

19 KB
Loading

Design/search_filter.png

20.5 KB
Loading

docs/getting_started/changelog.rst

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,15 @@
22

33
Changelog
44
---------
5+
6+
v1.1.0
7+
^^^^^^
8+
* Fixed the issue with the keyboard shortcut by making it user-configurable.
9+
* Fixed broken behavior of drag and drop.
10+
* Made the UI more consistent.
11+
* Added a new feature to rename the code snippet in the code snippet panel easily by double-clicking its name.
12+
* Improved the search feature with fuzzy search.
13+
514
v1.0.4
615
^^^^^^
716
* Fixed the issue with deleting a snippet while searching or filtering

docs/getting_started/overview.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ Overview
66
JupyterLab Code Snippets empowers you to write code more rapidly
77
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88

9+
.. image:: ../../Design/overview.gif
10+
911
Do you find yourself typing in the same code blocks over and over again?
1012
Are you tired of clicking through tabs online for starter code or
1113
browsing old notebook files to find the right import statements? Save,

docs/user/features.rst

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,17 +6,21 @@ Creation of a New Snippet
66

77
- Right click and save highlighted code (lines of code)
88
- Drag cell into panel to save (lines of code)
9+
.. image:: ../../Design/add_snippet.png
10+
911
- Plus button to create a new snippet from scratch
12+
.. image:: ../../Design/add_custom_snippet.png
1013

1114
Use of Code Snippets
1215
--------------------
13-
16+
.. image:: ../../Design/options.png
1417
- Copy, Insert, Delete snippet
1518
- Drag snippet into any JupyterLab workspace
1619

1720
Search of Code Snippets
1821
-----------------------
1922

23+
.. image:: ../../Design/search_filter.png
2024
- Scrollable/resizable snippet explorer panel displaying snippets
2125
- Move snippet within snippet explorer
2226
- Search bar for snippets
@@ -26,4 +30,5 @@ Search of Code Snippets
2630
Edit of Existing Code Snippets
2731
------------------------------
2832

33+
.. image:: ../../Design/codeSnippetEditor.png
2934
- Code Snippet Editor

0 commit comments

Comments
 (0)