doc_index.html

---
layout: default
title: Documentation
canonical_url: /doc/
---

{% include nav.html active='Documentation' %}

<section class="front-section">
  <div class="container">
    <div class="col-wide">

      <h1>Documentation</h1>

      <p>
        The following resources are available online for users and developers of Neovim:
      </p>

      <h2>Users</h2>

      <h3>Installation Instructions</h3>

      <p>
        Neovim is currently under development, and no releases have been published yet. To install a pre-alpha, experimental version of Neovim, please refer to the <a href="https://github.com/neovim/neovim/wiki/Installing-Neovim">installation instructions in the Neovim Wiki</a>.
      </p>

      <h3>User Manual</h3>

      <p>
        If you have installed Neovim, execute the <code>:help</code> command to access its <a href="http://neovim.io/doc/user">user manual</a>. For an overview of features specific to Neovim, see the <a href="http://neovim.io/doc/user/nvim.html">introduction to Nvim</a> (<code>:help nvim-intro</code>). This also contains instructions on how to enable support for <a href="http://neovim.io/doc/user/nvim_python.html">Python plugins</a> (<code>:help nvim-python</code>) such as YouCompleteMe.
      </p>

      <p>
        Other helpful resources for both Neovim and Vim are the <a href="http://neovim.io/doc/user/quickref.html">quick reference guide</a> (<code>:help quickref</code>) and the <a href="http://vimhelp.appspot.com/vim_faq.txt.html">Vim FAQ</a>.
      </p>

      <h3>Troubleshooting</h3>

      <p>
        Lots of information is available in the <a href="https://github.com/neovim/neovim/wiki">Neovim Wiki</a>. In particular, refer to the <a href="https://github.com/neovim/neovim/wiki/FAQ">FAQ</a> and <a href="https://github.com/neovim/neovim/wiki/Troubleshooting">Troubleshooting</a> pages if you encounter problems. Breaking changes in unstable versions of Neovim are listed on <a href="https://github.com/neovim/neovim/wiki/Following-HEAD">Following HEAD</a>.
      </p>

      <p>
        If you're stuck, you can reach out to the <a href="/community">Neovim community</a> for help.
      </p>

      <h2>Developers & Contributors</h2>

      <h3>Neovim Wiki</h3>
      <p>
        <a href="https://github.com/neovim/neovim/wiki">Neovim's wiki</a> contains a number of links, hints and guides for Neovim users and developers.
      </p>

      <h3>Developer Documentation</h3>
      <p>
        Visit the <a href="/doc/dev">developer documentation page</a> for an up-to-date Doxygen documentation of Neovim's code.
      </p>

      <h3>Clang Report</h3>
      <p>
      Clang's static analyzer is executed periodically on the Neovim codebase. A list of current issues is published in the <a href="/doc/reports/clang">static analysis report</a>.
      </p>

      <h3>Coverity Report</h3>
      <p>
        A list of issues found by Coverity is available at the <a href="https://scan.coverity.com/projects/2227">Neovim Coverity project</a>. To get access, have a look at the <a href="https://github.com/neovim/neovim/wiki/Contributing#coverity">hints on the Neovim wiki</a>.
      </p>

      <h3>Translation Report</h3>
      <p>
        An overview of the current status of translations in Neovim is published on the <a href="/doc/reports/translations">translation report page</a>.
      </p>

    </div>
  </div>
</section>