diff --git a/docusaurus-docs/docusaurus.config.js b/docusaurus-docs/docusaurus.config.js index e1e8cace0..00800a4e3 100644 --- a/docusaurus-docs/docusaurus.config.js +++ b/docusaurus-docs/docusaurus.config.js @@ -183,6 +183,11 @@ const config = { '⚠️ We are in the process of revamping our docs, some pages may be incomplete or inaccurate. ⚠️', isCloseable: false, }, + docs: { + sidebar: { + hideable: true, + }, + }, }), }; diff --git a/docusaurus-docs/jupyterlab-conda-store/images/conda-store-menu-item.png b/docusaurus-docs/jupyterlab-conda-store/images/conda-store-menu-item.png new file mode 100644 index 000000000..4ce4c05aa Binary files /dev/null and b/docusaurus-docs/jupyterlab-conda-store/images/conda-store-menu-item.png differ diff --git a/docusaurus-docs/jupyterlab-conda-store/install-extension.md b/docusaurus-docs/jupyterlab-conda-store/install-extension.md deleted file mode 100644 index 06db94012..000000000 --- a/docusaurus-docs/jupyterlab-conda-store/install-extension.md +++ /dev/null @@ -1,6 +0,0 @@ ---- -sidebar_position: 2 -description: Install jupyterlab-conda-store ---- - -# Install JupyterLab extension diff --git a/docusaurus-docs/jupyterlab-conda-store/introduction.md b/docusaurus-docs/jupyterlab-conda-store/introduction.md deleted file mode 100644 index 709c4f44a..000000000 --- a/docusaurus-docs/jupyterlab-conda-store/introduction.md +++ /dev/null @@ -1,7 +0,0 @@ ---- -sidebar_position: 1 -title: Introduction -description: Introduction to JupyterLab Extension. ---- - -# conda-store JupyterLab extension diff --git a/docusaurus-docs/jupyterlab-conda-store/introduction.mdx b/docusaurus-docs/jupyterlab-conda-store/introduction.mdx new file mode 100644 index 000000000..bcbb26cd2 --- /dev/null +++ b/docusaurus-docs/jupyterlab-conda-store/introduction.mdx @@ -0,0 +1,73 @@ +--- +title: Introduction +description: Introduction to JupyterLab Extension. +--- + +import Tabs from '@theme/Tabs'; +import TabItem from '@theme/TabItem'; + +# conda-store JupyterLab extension + +An extension to use the [conda-store UI][conda-store-ui] - a React-based frontend for conda-store, within JupyterLab. + +## Install 📦 + +1. Pre-requisites: `conda-store-server`, JupyterLab >= 3.0 and <= 4.0, and Python >= 3.8 installed. + +2. Install the extension: + + + + + +```bash +conda install -c conda-forge jupyter-lab-conda-store +``` + + + + + +```bash +pip install jupyterlab-conda-store +``` + + + + + +3. Start JupyterLab: + +```bash +jupyter lab +``` + +4. (Optional) Uninstall the extension + + + + +```bash +conda uninstall jupyter-lab-conda-store +``` + + + +```bash +pip uninstall jupyterlab-conda-store +``` + + + +## Usage + +In the JupyterLab window, click on the `conda-store` menu bar item to open the UI in a new window within JupyterLab: + +![JupyterLab window's menu bar with `conda-store` at the end of the list containing the `Conda Store Package Manager` option](./images/conda-store-menu-item.png) + +Learn to use the interface with [conda-store UI tutorials][cs-ui-tutorials]. + + + +[conda-store-ui]: /conda-store-ui/introduction +[cs-ui-tutorials]: /conda-store-ui/tutorials