Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jmbuhr/quarto-nvim-kickstarter
Neovim configuration to show my plugins in action.
https://github.com/jmbuhr/quarto-nvim-kickstarter
Last synced: 1 day ago
JSON representation
Neovim configuration to show my plugins in action.
- Host: GitHub
- URL: https://github.com/jmbuhr/quarto-nvim-kickstarter
- Owner: jmbuhr
- License: mit
- Created: 2022-06-03T07:59:41.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-11-06T15:07:28.000Z (7 days ago)
- Last Synced: 2024-11-06T16:20:46.472Z (7 days ago)
- Language: Lua
- Homepage:
- Size: 439 KB
- Stars: 228
- Watchers: 9
- Forks: 53
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# Quarto Nvim Kickstarter
Companion to .
This requires Neovim >= **v0.9.5** (https://github.com/neovim/neovim/releases/tag/stable)
## Videos
Check out this playlist for a full guide and walkthrough:
https://youtube.com/playlist?list=PLabWm-zCaD1axcMGvf7wFxJz8FZmyHSJ7
## Setup
Clone this repo into `~/.config/nvim/` or copy-paste just the parts you like.
If you already have your own configuration, check out `lua/plugins/quarto.lua`
for the configuration of plugins directly relevant to your Quarto experience.
The comments in this file will also point to to other plugins required for
the full functionality.
This configuration can make use of a "Nerd Font" for icons and symbols.
Download one here: and set it as your terminal font.
### Unix, Linux Installation
```bash
git clone https://github.com/jmbuhr/quarto-nvim-kickstarter.git ~/.config/nvim
```
For displaying images in your terminal a recent version of [kitty](https://sw.kovidgoyal.net/kitty/) or [wezterm](https://wezfurlong.org/wezterm/index.html) is required
as well as the dependecies of [image.nvim](https://github.com/3rd/image.nvim) (see `./lua/plugins/ui.lua`).
Additionally, if you plan to use this through [tmux](https://github.com/tmux/tmux) make sure to have version >= 3.3a.
If you are unable to install those in your enviroment, disable the plugin by setting `enabled = false`.
Example dependencies install on ubuntu-based systems:
```bash
sudo apt install imagemagick
sudo apt install libmagickwand-dev
sudo apt install liblua5.1-0-dev
sudo apt install luajit
sudo apt install tree-sitter-cli
```
Manually installing luarocks and the magick rock is no longer required, this is handled by [luarocks.nvim](https://github.com/vhyrro/luarocks.nvim).
> [!NOTE] Do this before opening nvim, otherwise `luarocks.nvim`
> might pick up the wrong luarocks version.
> If you forgot this step, you can do `:Lazy build luarocks.nvim` again manually after installation
> to fix it.
### Windows Powershell Installation
```bash
git clone https://github.com/jmbuhr/quarto-nvim-kickstarter.git "$env:LOCALAPPDATA\nvim"
```
The telescope file finder uses `fzf` for fuzzy finding via the [telescope-fzf-native](https://github.com/nvim-telescope/telescope-fzf-native.nvim) extension.
It will automatically install `fzf`, but needs some requirements which are not pre-installed on Windows.
Check out the previous link for those (or comment out the extension in `./lua/plugins/ui.lua`).
Now you are good to go!
## Updating
Certain updates to plugins may leave behind unused plugin data. If this configuration produces an error on startup, try removing those first, allowing the lazy.nvim package manager to recreate the correct plugin structure:
```bash
rm -r ~/.local/share/nvim
rm -r ~/.local/state/nvim
```
## Screenshots
Use the integrated neovim terminal to execute code chunks:
