docs: Add a section about extension in docs

mwouts · Nov 10, 2023 · 36f2595 · 36f2595
1 parent 2cb470d
commit 36f2595
Show file tree

Hide file tree

Showing 5 changed files with 32 additions and 0 deletions.
diff --git a/docs/images/jupyterlab_launcher.png b/docs/images/jupyterlab_launcher.png
diff --git a/docs/images/jupyterlab_main_menu.png b/docs/images/jupyterlab_main_menu.png
diff --git a/docs/images/jupyterlab_settings.png b/docs/images/jupyterlab_settings.png
diff --git a/docs/index.md b/docs/index.md
@@ -10,6 +10,7 @@
 install.md
 text-notebooks.md
 paired-notebooks.md
+jupyterlab-extension.md
 config.md
 advanced-options.md
 formats-scripts.md

diff --git a/docs/jupyterlab-extension.md b/docs/jupyterlab-extension.md
@@ -0,0 +1,31 @@
+# Frontend extension
+
+Recent versions of Jupytext (`>=1.16.0`) ships frontend extension that enables users 
+to create text notebooks and pair notebooks from main menu of JupyterLab 4 and 
+Notebook 7. In addition, the frontend extension adds selected Jupytext text 
+notebook formats to launcher in the `Jupytext` section so that users can launch text 
+notebooks as they launch a regular notebook from JupyterLab launcher.
+
+## Launcher icons
+
+After installing Jupytext extension, users will have a new category in the launcher 
+called Jupytext as shown below:
+
+![](images/jupyterlab_launcher.png)
+
+Users can remove and/or add new formats to the Jupytext section _via_ `Settings>Jupytext`. 
+
+![](images/jupyterlab_settings.png)
+
+By clicking `Add` and adding a new format, say `qmd`, will 
+add the Quatro Text Notebook to the launcher. **Note** that users need to refresh the current browser tab when they modify the settings for them to take effect. 
+
+Besides, users can also change the category of Text Notebook launcher icons using 
+`Category` field in the Settings. For example, by using `Notebook` as category, all 
+Text Notebook launchers will be moved into `Notebook` category.
+
+## Main menu
+
+It is also possible to launch text notebooks and/or pair existing notebooks from the dedicated Jupytext main menu as shown below. 
+
+![](images/jupyterlab_main_menu.png)