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 for users and developers.
      </p>

      <h2>User</h2>

      <p>The user manual is available <a href="http://neovim.io/doc/user">online</a>
         and in Neovim with the <code>:help</code> command.
      </p>

      <ul>
        <li>
          <a href="https://github.com/neovim/neovim/wiki/Installing-Neovim"><em>Install</em></a>
        </li>
        <li>For a list of Neovim-specific features see
            <a href="https://neovim.io/doc/user/vim_diff.html#nvim-features"><code>:help nvim-features</code></a></li>
        <li>To use python plugins (such as YouCompleteMe) see
            <a href="http://neovim.io/doc/user/provider.html#provider-python"><code>:help provider-python</code></a></li>
        <li><a href="http://neovim.io/doc/user/quickref.html"><code>:help quickref</code></a>
            is a dense reference for regular users</li> 
        <li>
          <a href="http://vimhelp.appspot.com/vim_faq.txt.html">Vim FAQ</a>
          is an extensive collection of "how to" answers.
        </li>
        <li>Check the <b><a href="https://github.com/neovim/neovim/wiki/FAQ">FAQ</a></b>
            for solutions to common issues.</li>
        <li>Breaking changes are documented at
            <b><a href="https://github.com/neovim/neovim/wiki/Following-HEAD">Following HEAD</a></b>.</li>
      </ul>

      <h2>Developer</h2>

      <h3>Code</h3>
      <ul>
        <li>
          <a href="https://neovim.io/doc/user/develop.html#dev"><code>:help dev</code></a>
          and the <a href="https://github.com/neovim/neovim/wiki">wiki</a>
          are the primary sources of developer information.
        </li>
        <li><a href="/doc/dev/files.html">Source code documentation</a> generated by Doxygen</li>
      </ul>

      <h3>Static Analysis</h3>
      <ul>
        <li>
          <a href="https://neovim.io/doc/reports/pvs/">PVS-studio analysis</a>
          runs daily.
        </li>
        <li>
          <a href="/doc/reports/clang">Clang-scan analysis</a> runs on every commit.
        </li>
        <li>
          <a href="https://scan.coverity.com/projects/2227">Coverity static analysis</a>
           runs daily. To get access, see the
           <a href="https://github.com/neovim/neovim/blob/master/CONTRIBUTING.md#coverity">contribution guidelines</a>.
        </li>
        <li><a href="/doc/reports/translations">Translation report page</a></li>
      </ul>

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