Dark Mode

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

Sign up
Appearance settings

neovim/neovim.github.io

Repository files navigation

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:

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

Site search

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:

<link href="/css/neovim-hi.css" rel="stylesheet">
and fiddle with the [markup] section in hugo.toml.

About

Neovim website

Resources

Readme

License

MIT license

Stars

Watchers

Forks

Contributors