.. ycm-wiki-zhcn documentation master file, created by
   sphinx-quickstart on Tue Sep 25 13:15:33 2018.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

Wiki 介绍
=========

Vim_ 代码补全插件 YouCompleteMe_ (*后续简称 ycm*) 中文 Wiki，包含：

.. _Vim: https://www.vim.org
.. _YouCompleteMe: https://github.com/Valloric/YouCompleteMe

-  官方文档完全翻译
-  其他帮助文档

当前状态
--------

**安装**部分已经基本完成翻译

其他模块翻译中...

对应版本的 COMMIT_ ，可能会和最新官方文档内容有出入，如果发现请告知

.. _COMMIT: https://github.com/Valloric/YouCompleteMe/commit/f67e5ff27b048d8c55a10ba6a27c6c5b16d0f6ba

参与维护
--------

本 Wiki 由 K_ 创建，致力于为有需要的用户提供详尽的 ycm 中文文档，欢迎任何人参与维护。你可以点击 `项目地址 <https://github.com/Karmenzind/ycm-wiki-zhcn>`_ ，以 Fork 的方式进行你的修改并提交 PR，它可以是新的翻译、纠错或其他任何你觉得有益的 ycm 相关内容，你的名字将出现在首页的贡献列表。

.. _K: https://github.com/Karmenzind

如果有任何问题、意见和建议，也欢迎在 `此处 <https://github.com/Karmenzind/ycm-wiki-zhcn>`_ 创建issue。


索引
----

* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

.. toctree::
   :maxdepth: 1

    WIKI说明 <index>


.. toctree::
   :maxdepth: 3
   :caption: 官方文档完全翻译

   * 保留翻译词 <official_doc/remained>
   official_doc/intro

.. toctree::
    :caption: 链接
    
    WIKI repo <https://github.com/Karmenzind/ycm-wiki-zhcn>
    YCM repo <https://github.com/Valloric/YouCompleteMe>