summaryrefslogtreecommitdiffstats
path: root/docs/clangd/index.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/clangd/index.rst')
-rw-r--r--docs/clangd/index.rst27
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/clangd/index.rst b/docs/clangd/index.rst
new file mode 100644
index 00000000..46939062
--- /dev/null
+++ b/docs/clangd/index.rst
@@ -0,0 +1,27 @@
+======
+clangd
+======
+
+.. toctree::
+ :maxdepth: 1
+
+ Installation
+ Features
+
+What is clangd?
+===============
+
+clangd understands your C++ code and adds smart features to your editor: code
+completion, compile errors, go-to-definition and more.
+
+clangd is a language server that implements the `Language Server Protocol
+<https://github.com/Microsoft/language-server-protocol>`__; it can work with
+many editors through a plugin. Here's Visual Studio Code with the clangd
+plugin, demonstrating code completion:
+
+.. image:: CodeCompletionInVSCode.png
+ :align: center
+ :alt: Code completion in VSCode
+
+clangd is based on the `Clang <https://clang.llvm.org>`__ C++ compiler, and is
+part of the `LLVM <https://llvm.org>`__ project.