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. Build and view the website locally:

   hugo server --buildDrafts
   

3. Open http://localhost:1313/ to view the website.

Maintenance

Notes:

• Updating content/doc2/ currently requires a human to run: ./sync_docs.sh
• Files in content/doc2/ are synced to https://github.com/neovim/doc/ by this CI job.
  • This is because neovim.io/doc/ is served by https://github.com/neovim/doc/ (where the user documentation HTML is published).
• 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
• Codeblock highlighting
  • The highlighting for the generated help docs (/doc/user/) is done by:
    • static/css/neovim-hi.css
    • static/highlight/styles/neovim.min.css
    • gen_help_html.lua references those css files.
  • 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: https://github.com/neovim/neovim.github.io/blob/eb266d7929eff8693cc05ca96732a2daf431e834/layouts/_default/baseof.html#L27
      • And fiddle with the [markup] section in hugo.toml.