Skip to content

Commit 8f8a1c2

Browse files
committed
docs: update readme
1 parent 5e6178b commit 8f8a1c2

File tree

3 files changed

+16
-28
lines changed

3 files changed

+16
-28
lines changed

README.md

Lines changed: 16 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -1,37 +1,31 @@
1-
![Deepnote JupyterLab cover image](deepnote-jupyterlab-cover-image.png)
2-
31
<div align="center">
42

3+
![Deepnote JupyterLab cover image](/assets/deepnote-jupyterlab-cover-image.png)
4+
55
[![CI](https://github.com/deepnote/jupyterlab-deepnote/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/deepnote/jupyterlab-deepnote/actions/workflows/ci.yml)
66
[![codecov](https://codecov.io/gh/deepnote/jupyterlab-deepnote/graph/badge.svg?token=OV32VZNOJ2)](https://codecov.io/gh/deepnote/jupyterlab-deepnote)
77
[![PyPI](https://img.shields.io/pypi/v/jupyterlab-deepnote.svg)](https://pypi.org/project/jupyterlab-deepnote/)
88
[![Python Version](https://img.shields.io/pypi/pyversions/jupyterlab-deepnote.svg)](https://pypi.org/project/jupyterlab-deepnote/)
9-
[![License](https://img.shields.io/badge/License-BSD_3--Clause-blue.svg)](https://opensource.org/licenses/BSD-3-Clause)
10-
11-
## A third-party extension for JupyterLab for viewing Deepnote projects (`.deepnote` files) directly in JupyterLab
129

13-
> **Note:** This is an unofficial, community-developed extension and is not affiliated with or endorsed by Project Jupyter. Jupyter, JupyterLab and the Jupyter logos are trademarks or registered trademarks of LF Charities, used by Deepnote Inc with permission.
14-
15-
[Installation](#installation)[Usage](#usage)[Development](#development)[License](#license)[Deepnote](https://deepnote.com)[GitHub community](https://github.com/deepnote/deepnote)
10+
[Website](https://deepnote.com/?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main)[Docs](https://deepnote.com/docs?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main)[Changelog](https://deepnote.com/changelog?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main)[X](https://x.com/DeepnoteHQ)[Examples](https://deepnote.com/explore?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main)[Community](https://github.com/deepnote/deepnote/discussions)
1611

1712
</div>
1813

19-
---
14+
# Deepnote extension for JupyterLab
2015

2116
Deepnote is the data notebook for the AI era. `jupyterlab-deepnote` is a JupyterLab extension that enables you to open and view [Deepnote](https://deepnote.com) project files (`.deepnote` format) directly within JupyterLab. This extension provides a seamless read-only viewer for Deepnote notebooks, allowing you to explore Deepnote projects without leaving your JupyterLab environment.
2217

23-
### Key features
18+
## Key features
2419

25-
- 📂 **Open Deepnote files**: View `.deepnote` project files containing Deepnote notebooks in JupyterLab
26-
- 📓 **Multi-notebook support**: Switch between multiple notebooks within a single `.deepnote` file
27-
- 👁**Read-only mode**: View notebook content safely without modifying the original `.deepnote` file
28-
- 🔄 **Seamless integration**: Works natively with JupyterLab's notebook interface
29-
- 🎨 **Deepnote block support**: Renders Deepnote-specific block types as Jupyter cells
20+
- **Open Deepnote files**: View `.deepnote` project files containing Deepnote notebooks in JupyterLab
21+
- **Multi-notebook support**: Switch between multiple notebooks within a single `.deepnote` file
22+
-**Read-only mode**: View notebook content safely without modifying the original `.deepnote` file
23+
- **Seamless integration**: Works natively with JupyterLab's notebook interface
24+
- **Deepnote block support**: Renders Deepnote-specific block types as Jupyter cells
3025

3126
## Installation
3227

3328
### Requirements
34-
3529
- **Python**: 3.10 or higher
3630
- **JupyterLab**: 4.4.0 or higher
3731

@@ -59,9 +53,7 @@ jupyter labextension list
5953

6054
You should see `jupyterlab_deepnote` listed in both outputs.
6155

62-
## Usage
63-
64-
### Opening Deepnote files
56+
## Opening Deepnote files
6557

6658
1. **Launch JupyterLab**:
6759

@@ -137,13 +129,13 @@ After uninstalling, restart JupyterLab for the changes to take effect.
137129

138130
## Compatibility
139131

140-
### JupyterLab Version Support
132+
### JupyterLab version support
141133

142134
This extension is compatible with **JupyterLab 4.4.0 or higher**. It requires the content provider registry API introduced in JupyterLab 4.4.
143135

144136
**Upper bound:** The extension sets an upper bound of `< 5.0.0` to prevent automatic installation with potentially incompatible future major versions of JupyterLab.
145137

146-
### Maintenance Policy
138+
### Maintenance policy
147139

148140
Following [JupyterLab's extension development guidelines](https://jupyterlab.readthedocs.io/en/stable/extension/extension_dev.html#overview-of-extensions), we adhere to semantic versioning principles:
149141

@@ -157,7 +149,7 @@ When JupyterLab 5.x is released, we will:
157149
2. Release a new major or minor version with explicit JupyterLab 5.x support
158150
3. Clearly document any breaking changes in the changelog
159151

160-
### Backwards Compatibility
152+
### Backwards compatibility
161153

162154
This extension follows semantic versioning for its own API:
163155

@@ -166,14 +158,10 @@ This extension follows semantic versioning for its own API:
166158

167159
Note: This extension does **not** support JupyterLab 3.x or earlier versions.
168160

169-
## Development
161+
## Contributing
170162

171163
For development setup, testing, and contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).
172164

173-
## License
174-
175-
This project is licensed under the BSD 3-Clause License - see the [LICENSE](LICENSE) file for details.
176-
177165
## Related projects
178166

179167
- [Deepnote](https://deepnote.com)
@@ -186,6 +174,6 @@ This project is licensed under the BSD 3-Clause License - see the [LICENSE](LICE
186174

187175
<div align="center">
188176

189-
Made with 💙 by the Deepnote team
177+
Made with 💙 by the data-driven team
190178

191179
</div>
1.44 MB
Loading
-6.46 MB
Binary file not shown.

0 commit comments

Comments
 (0)