Neovim.io website
This repository contains the source for the neovim.io website.
To report a bug Neovim, go here: https://github.com/neovim/neovim
Contributing
Just fork this repository and send us a pull request! :-)
Setup
This site is statically generated using Hugo. It takes one minute to get setup, just do the following:
- Install Hugo
brew install hugo
- (Optional) To include the documentation pages locally:
./gendoc.lua <path>/<to>/<nvim>
- Build and view the website locally:
hugo serve -D
- Open http://localhost:1313/ to view the website.
Maintenance
Creating content / blog posts
Create new blog posts (news items) using the command:
The filename won't show up on the site -- the page url will be in the form of
/news/2026/12/ where 2026 is the year and 12 the month, as defined in
hugo.toml.
To include (Markdown) content separate from the main content, use the
scratch shortcode and add
{{ .Page.Scratch.Get " in the layout of that page. See #457 for an
example.
Site search
Site search (for :help docs) is served by Algolia Docsearch.
- The javascript and UI container were setup in this commit.
- The docs pages don't use the layout so they also need to manually include the javascript and define a UI container.
- Admin: https://www.algolia.com/apps/X185E15FPG/dashboard
- Config: algolia-docsearch-config.js
Codeblock highlighting
See neovim-hi.css and
neovim.min.css for the highlighting
of code examples in generated help docs (/doc/user/).
Hugo can provide highlighting for markdown codeblocks, see the [markup]
section in hugo.toml. To list/generate Hugo syntax themes:
To use the them, commit static/css/syntax.css and enable it by uncommenting
this line:
| <link href="/css/neovim-hi.css" rel="stylesheet"> |
[markup] section in hugo.toml.