Skip to content

neovim/neovim.github.io

master
Switch branches/tags
Code

Latest commit

Problem:
The "dev docs" layout has been broken for 1+ years. There is no evidence
that anyone uses the online form of these docs. Nvim LSP support
provides dynamic access to the Nvim source docstrings. We also use the
C docstrings to generate things like ":help api" and ":help ui".

Solution:
- Remove references to the doxygen docs.
- Remove doxygen job from the neovim/doc repo. neovim/doc#28
- FUTURE: ":help dev" and other :help docs will continue to be improved
  as the "source of truth" for developer-related docs.

closes #247
17d59d8

Git stats

Files

Permalink
Failed to load latest commit information.
Type
Name
Latest commit message
Commit time
 
 
 
 
 
 
 
 
css
 
 
 
 
 
 
 
 
 
 
js
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

neovim.io website

This repository contains the source for the neovim.io website. The Neovim core project is: https://github.com/neovim/neovim Note that www.neovim.io/doc is served by https://github.com/neovim/doc (which previoulsy crawled neovim.io/doc2 generated from this repository).

Contributing

Just fork this repository and send us a pull request! :-)

Setup

This assumes that you already have a recent Ruby with RubyGems.

Installing Ruby gems

Install Bundler, either systemwide:

$ sudo gem install bundler

or for the current user:

$ export PATH="$(ruby -e 'print Gem.user_dir')/bin:$PATH"
$ gem install --user-install bundler

In the latter case, you might want to add the PATH update to .bashrc or your shell's equivalent.

To install the dependencies for this project only:

$ bundle config set --local path .bundle
$ bundle install

Serving locally

Execute the following command:

$ bundle exec jekyll serve --watch --livereload

Open http://localhost:4000 to view the website.

License

© 2014 Cameron Eagans and Josh Branchaud

Licensed under the MIT License. See LICENSE for details.