https://github.com/ahmedkhalf/jupyter-nvim
Jupyter notebook client in neovim
https://github.com/ahmedkhalf/jupyter-nvim
Last synced: 12 days ago
JSON representation
Jupyter notebook client in neovim
- Host: GitHub
- URL: https://github.com/ahmedkhalf/jupyter-nvim
- Owner: ahmedkhalf
- License: mit
- Created: 2021-06-02T11:25:11.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2021-07-11T14:11:20.000Z (almost 4 years ago)
- Last Synced: 2024-08-07T18:43:16.072Z (10 months ago)
- Language: Python
- Homepage:
- Size: 42 KB
- Stars: 96
- Watchers: 8
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 🪐 Jupyter-Nvim
Read jupyter notebooks in neovim
*Note:* The plugin is still in alpha stage
## ⚡️ Requirements
- Neovim >= 0.5.0
## 📦 Installation
Install the plugin with your preferred package manager:
### [vim-plug](https://github.com/junegunn/vim-plug)
```vim
" Vim Script
Plug 'ahmedkhalf/jupyter-nvim', { 'do': ':UpdateRemotePlugins' }
lua << EOF
require("jupyter-nvim").setup {
-- your configuration comes here
-- or leave it empty to use the default settings
-- refer to the configuration section below
}
EOF
```
### [packer](https://github.com/wbthomason/packer.nvim)
```lua
-- Lua
use {
"ahmedkhalf/jupyter-nvim",
run = ":UpdateRemotePlugins",
config = function()
require("jupyter-nvim").setup {
-- your configuration comes here
-- or leave it empty to use the default settings
-- refer to the configuration section below
}
end
}
```
## ⚙️ Configuration
**jupyter-nvim** comes with the following defaults:
```lua
{
-- Nothing till now
}
```
## 👾 Usage
Just open any `*.ipynb` file and voila!
## ✨ Contributing
All contributions are welcome! Even bug report count as a contribution, so if there is anything off don't hesitate to open an issue.
## 🚀 TODO
You can find the todo on [github projects](https://github.com/ahmedkhalf/jupyter-nvim/projects/1).