Skip to content

Commit 4eede54

Browse files
docs: update readme (#69)
* docs: update readme * docs: update links in readme Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> * docs: update logo and readme * docs: update with prettier * docs: update readme --------- Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
1 parent 5e6178b commit 4eede54

File tree

3 files changed

+24
-37
lines changed

3 files changed

+24
-37
lines changed

README.md

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

3+
![Deepnote cover image](./assets/deepnote-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

21-
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.
16+
`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

@@ -59,9 +54,7 @@ jupyter labextension list
5954

6055
You should see `jupyterlab_deepnote` listed in both outputs.
6156

62-
## Usage
63-
64-
### Opening Deepnote files
57+
## Opening Deepnote files
6558

6659
1. **Launch JupyterLab**:
6760

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

138131
## Compatibility
139132

140-
### JupyterLab Version Support
133+
### JupyterLab version support
141134

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

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

146-
### Maintenance Policy
139+
### Maintenance policy
147140

148141
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:
149142

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

160-
### Backwards Compatibility
153+
### Backwards compatibility
161154

162155
This extension follows semantic versioning for its own API:
163156

@@ -166,26 +159,20 @@ This extension follows semantic versioning for its own API:
166159

167160
Note: This extension does **not** support JupyterLab 3.x or earlier versions.
168161

169-
## Development
162+
## Need help?
170163

171-
For development setup, testing, and contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).
172-
173-
## License
174-
175-
This project is licensed under the BSD 3-Clause License - see the [LICENSE](LICENSE) file for details.
164+
- Join our Community!
165+
- Open an issue for bug reports or feature requests
166+
- Check out source code of related repositories: [Deepnote Open Source](https://github.com/deepnote/deepnote), [JupyterLab extension](https://github.com/deepnote/jupyterlab-deepnote) and [Deepnote Toolkit](https://github.com/deepnote/deepnote-toolkit).
167+
- Check out our [documentation](https://deepnote.com/docs?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main)
168+
- Want a low-code experience? Visit [Deepnote Cloud](https://deepnote.com/?utm_source=github&utm_medium=github&utm_campaign=github&utm_content=readme_main) together with Deepnote AI agent
176169

177-
## Related projects
170+
## Contributing
178171

179-
- [Deepnote](https://deepnote.com)
180-
- [Deepnote Open Source](https://github.com/deepnote/deepnote)
181-
- [VS Code extension](https://marketplace.visualstudio.com/items?itemName=Deepnote.vscode-deepnote)
182-
- [Cursor extension](https://open-vsx.org/extension/Deepnote/vscode-deepnote)
183-
- [Windsurf extension](https://open-vsx.org/extension/Deepnote/vscode-deepnote)
172+
For development setup, testing, and contributing guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).
184173

185174
---
186175

187176
<div align="center">
188-
189-
Made with 💙 by the Deepnote team
190-
177+
Built with 💙
191178
</div>

assets/deepnote-cover-image.png

943 KB
Loading
-6.46 MB
Binary file not shown.

0 commit comments

Comments
 (0)