Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOC] Add JupyterLab Extension docs page #752

Merged
merged 10 commits into from
Mar 14, 2024
5 changes: 5 additions & 0 deletions docusaurus-docs/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -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,
pavithraes marked this conversation as resolved.
Show resolved Hide resolved
},
},
}),
};

Expand Down
6 changes: 0 additions & 6 deletions docusaurus-docs/jupyterlab-conda-store/install-extension.md

This file was deleted.

66 changes: 65 additions & 1 deletion docusaurus-docs/jupyterlab-conda-store/introduction.md
pavithraes marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,7 +1,71 @@
---
sidebar_position: 1
pavithraes marked this conversation as resolved.
Show resolved Hide resolved
title: Introduction
description: Introduction to JupyterLab Extension.
---

# conda-store JupyterLab extension

A extension to use the [conda-store UI][conda-store-ui] - a React-based frontend for conda-store, within JupyterLab.
pavithraes marked this conversation as resolved.
Show resolved Hide resolved

## Install 📦

1. Pre-requisites: `conda-store-server`, JupyterLab `>=` 3.0 and `<=` 4.0, and Python `>=` 3.8 installed.
pavithraes marked this conversation as resolved.
Show resolved Hide resolved

2. Install the extension:

import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
pavithraes marked this conversation as resolved.
Show resolved Hide resolved

<Tabs>
pavithraes marked this conversation as resolved.
Show resolved Hide resolved

<TabItem value="conda" label="conda" default>

```bash
conda install -c conda-forge jupyter-lab-conda-store
```

</TabItem>

<TabItem value="pip" label="pip" default>

```bash
pip install jupyterlab-conda-store
```

</TabItem>

</Tabs>

3. Start JupyterLab:

```bash
jupyter lab
```

4. (Optional) Uninstall the extension

<Tabs>
<TabItem value="conda" label="conda" default>

```bash
conda uninstall jupyter-lab-conda-store
```
</TabItem>
<TabItem value="pip" label="pip" default>

```bash
pip uninstall jupyterlab-conda-store
```
</TabItem>
</Tabs>

## Usage

In the JupyterLab window, click on `conda-store` menu-bar item to open the UI in a new window within JupyterLab.
pavithraes marked this conversation as resolved.
Show resolved Hide resolved
pavithraes marked this conversation as resolved.
Show resolved Hide resolved

Learn to use the interface with [conda-store UI tutorials][cs-ui-tutorials].

<!-- Internal links -->

[conda-store-ui]: /conda-store-ui/introduction
[cs-ui-tutorials]: /conda-store-ui/tutorials
Loading