Neovim website
  • HTML 45.6%
  • CSS 40.2%
  • Lua 7.7%
  • JavaScript 6.5%
Find a file
Repository files (latest commit first)
Filename Latest commit message Latest commit date
Justin M. Keyes a421cc5296
Merge #518 from vtmx/navbar
Refine menu
2026-11-15 21:49:08 +01:00
.github ci: generate :help (vimdoc) PDF 2026-10-15 17:41:50 +02:00
archetypes feat: Generate doc/user/ pages with Hugo #437 2026-02-23 17:37:56 -05:00
content docs: link to help PDF #512 2026-10-15 13:07:14 -04:00
layouts docs: use the :help doc's own title #513 2026-10-18 07:23:02 -04:00
static style: menu 2026-11-15 21:41:49 +01:00
.editorconfig style: add editorconfig, fix whitespace 2024-08-09 20:15:58 +02:00
.gitignore ci: generate :help (vimdoc) PDF 2026-10-15 17:41:50 +02:00
algolia-docsearch-config.js docsearch: prefer /doc results over /news 2026-01-12 18:00:27 -05:00
gendoc.lua fix(gendoc): update args 2026-06-02 16:56:21 +02:00
hugo.toml config: "access denied: 'text/html' is not whitelisted" #482 2026-06-02 08:02:21 -04:00
LICENSE Adding MIT license. 2014-02-23 14:08:48 -03:00
README.md docs: README.md typo #487 2026-06-16 14:27:29 -04:00

Neovim.io website

This repository contains the source for the neovim.io website.

To report a Neovim bug, 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:

  1. Install Hugo
    brew install hugo
    
  2. (Optional) To include the documentation pages locally:
    ./gendoc.lua <path>/<to>/<nvim>
    
  3. Build and view the website locally:
    hugo serve -D
    
  4. Open http://localhost:1313/ to view the website.

Maintenance

Creating content / blog posts

Create new blog posts (news items) using the command:

hugo new content content/news/<filename>.md

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 "<name>" }} in the layout of that page. See #457 for an example.

Site search (for :help docs) is served by Algolia Docsearch.

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:

hugo gen chromastyles --style nord > static/css/syntax.css

To use the them, commit static/css/syntax.css and enable it by uncommenting this line: github.com/neovim/neovim.github.io@eb266d7929/layouts/_default/baseof.html (L27) and fiddle with the [markup] section in hugo.toml.