Skip to content

Commit

Permalink
install: neovide install and configuration
Browse files Browse the repository at this point in the history
  • Loading branch information
practicalli-johnny committed Dec 17, 2023
1 parent 97fcbb2 commit 075b0e1
Show file tree
Hide file tree
Showing 3 changed files with 83 additions and 0 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
- basic: Astronvim notification page with history navigation
- basics: configure neotree to show hidden files and directories
- install: add MacOSX homebrew section
- install: neovide install and configuration

### Changed
- ci: spell lychee & repository trufflehog linters warn only (false positives)
Expand Down
81 changes: 81 additions & 0 deletions docs/install/neovide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,81 @@
# Neovide GUI



![Neovide Gui Screenshot](https://neovide.dev/assets/neovide-128x128.png){align=right loading=lazy style="height:150px"}

Neovide provides a GUI for Neovim and supports the use of AstroNvim community configuration.

[:globe_with_meridians: Neovide features](https://neovide.dev/features.html){target=_blank}

## Install Neovide

[:globe_with_meridians: Download from Neovide.dev website](https://neovide.dev/)

=== "Debian"
[Download neovide.AppImage](https://github.com/neovide/neovide/releases/latest/download/neovide.AppImage)

Move the `neovide.AppImage` to the execution path, e.g. `$HOME/.local/bin`

Create the `$HOME/.local/bin/neovide` symbolic link pointing to the neovide.AppImage

!!! NOTE ""
```shell
ln -s $HOME/.local/bin/neovide.AppImage $HOME/.local/bin/neovide
```

=== "MacOSX"

[Download the MacOSX dmg.zip file](https://github.com/neovide/neovide/releases/latest/download/neovide.dmg.zip)

Extract the .zip file

Run the extracted dmg file and use the install wizard to copy Neovide to the Applications directory.



## Neovide with NVIM_APPNAME

`NVIM_APPNAME` sets the configuration used when starting Neovim.

Use a shell alias to run Neovide with a specific configuration

```shell
# Neovide alias with AstroNvim configuration
alias neovide="NVIM_APPNAME=astronvim neovide"
```


## Set Neovide Font

The `guifont` Neovim option is used to set a font family and size specifically for a GUI appliction, i.e. Neovide. It is not used by Neovim itself.


!!! EXAMPLE "Neovide font family and size"
```lua
guifont = "Fira Code:h16"
```


!!! EXAMPLE "AstroNvim Neovide font family and size"
[:fontawesome-solid-book-open: Practicalli AstroNvim Config](/neovim/configuration/astronvim/#clone-astronvim-user-config) includes the `guifont` option in the `options.lua` file.

```lua title="options.lua"
return {
opt = {
-- set to true or false etc.
relativenumber = true, -- sets vim.opt.relativenumber
number = true, -- sets vim.opt.number
spell = false, -- sets vim.opt.spell
signcolumn = "auto", -- sets vim.opt.signcolumn to auto
wrap = true, -- sets vim.opt.wrap
-- showtabline = 0, -- sets vim.opt.showtabline - zero hides tabs
timeoutlen = 420,
-- neovide font family & size
guifont = "Fira Code:h16",
},
}
```

![Neovide Gui Screenshot](https://neovide.dev/assets/BasicScreenCap.png){loading=lazy}

1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -139,6 +139,7 @@ nav:
- Overview: install/index.md
- Clojure: install/clojure.md
- Neovim: install/neovim.md
- Neovide: install/neovide.md
- Neovim configuration:
- configuration/index.md
- AstroNvim:
Expand Down

0 comments on commit 075b0e1

Please sign in to comment.