Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nicodebo/neovim-docker
personal neovim configuration as a Docker image. (I don't use this anymore. Feel free to fork it if you need to)
https://github.com/nicodebo/neovim-docker
docker neovim
Last synced: 3 days ago
JSON representation
personal neovim configuration as a Docker image. (I don't use this anymore. Feel free to fork it if you need to)
- Host: GitHub
- URL: https://github.com/nicodebo/neovim-docker
- Owner: nicodebo
- Created: 2018-03-25T09:46:28.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2022-04-20T12:57:50.000Z (over 2 years ago)
- Last Synced: 2024-10-31T05:34:53.397Z (14 days ago)
- Topics: docker, neovim
- Language: Dockerfile
- Homepage: https://hub.docker.com/r/nicodebo/neovim-docker/
- Size: 7.81 KB
- Stars: 37
- Watchers: 3
- Forks: 12
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Neovim-docker
My **personal** neovim environment (neovim + tools) as a Docker image
## Why ?
- Keep track of all external tools, specifically installed for neovim (ctags,
syntax checkers, language server protocol,…)
- Keep track of all installed plugins
- Easily deploy your developement environnement on different machine with
docker-hub
- Safely try new tools (e.g. language server protocol) in the sandbox environment
## Usage
`cd` into your top level project directory, then run the following docker
command:
```
docker run \
--rm -it \
[-e UID="1000" \]
[-e GID="1000" \]
[-v :/home/neovim/.config/nvim \]
-v :/mnt/workspace \
nicodebo/neovim-docker:latest \
[nvim arguments]
```
### Examples
* Open neovim with file1 and file2 stacked horizontally:
```
docker run \
--rm -it \
-v $(pwd):/mnt/workspace \
nicodebo/neovim-docker:latest \
-o file1 file2
```
* Open neovim with file1 and use your custom neovim configuration stored in the
`.dotfile` directory under your `$HOME`:
```
docker run \
--rm -it \
-v $(pwd):/mnt/workspace \
-v $HOME/.dotfiles/nvim:/home/neovim/.config/nvim \
nicodebo/neovim-docker:latest \
file1
```
* File permission issues may arise if the default `user id (1000)` and `group
id (1000)` of the container does not match user id and group id of the host.
```
docker run \
--rm -it \
-v $(pwd):/mnt/workspace \
-e UID="1003" \
-e GID="1004" \
nicodebo/neovim-docker:latest \
-o file1 file2
```
You can find out your host user id and group id with the following command: `$ id`
## Local runtime/binary
For conveniance, you might want to define a function in your shell
configuration (bashrc, zshrc,…) to run neovim-docker as an executable, e.g.:
```
nvim() {
docker run \
--rm -it \
-v $(pwd):/mnt/workspace \
-v $HOME/.dotfiles/nvim:/home/neovim/.config/nvim \
nicodebo/neovim-docker:latest \
"$@"
}
```
## Limitation
You must `cd` into the directory (preferably the top level directory of your
project) where the files you want to edit are located.
## Related project
*
*
*