Skip to content

Commit e1cc324

Browse files
committed
unify doc/ page, remove doc submenu
Problem: Submenus in the nav should be avoided, they are clunky. Eventually we should try to remove the other one. Solution: - Remove submenu for "Documenation" navigation item. We don't need subpages, just a single landing page. - Subpages should live in `:help` itself. - High-level info about LSP and treesitter can live on the "Documenation" landing page itself, rather than subpages. And also in the "Screenshots" or "Features" (TODO) pages. - The old subpages are preserved so that old links continue to work. ref neovim#271 close neovim#232
1 parent 012fce7 commit e1cc324

File tree

6 files changed

+34
-74
lines changed

6 files changed

+34
-74
lines changed

_data/nav.yml

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -13,14 +13,5 @@
1313
url: https://github.com/neovim/neovim
1414
- title: Documentation
1515
url: /doc/
16-
sections:
17-
- title: General
18-
url: /doc/
19-
- title: Lua resources
20-
url: /doc/lua-resources/
21-
- title: LSP
22-
url: /doc/lsp/
23-
- title: Tree-sitter
24-
url: /doc/treesitter/
2516
- title: Sponsors
2617
url: /sponsors/

doc2/index.html

Lines changed: 8 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -16,28 +16,23 @@ <h2>User</h2>
1616

1717
<h3><a href="https://github.com/neovim/neovim/wiki/Installing-Neovim">Install</a></h3>
1818
<p>
19-
<a href="https://github.com/neovim/neovim/releases">Download</a> an archive
19+
<a href="https://github.com/neovim/neovim/releases">Download a binary</a>
2020
or use a <a href="https://github.com/neovim/neovim/wiki/Installing-Neovim#install-from-package">package manager</a>.
2121
</p>
2222

23-
<h3><a href="https://github.com/neovim/neovim/wiki/FAQ">FAQ</a></h3>
24-
<p>
25-
Check the <a href="https://github.com/neovim/neovim/wiki/FAQ">FAQ</a>
26-
and <a href="https://github.com/neovim/neovim/wiki/Following-HEAD">breaking changes</a> for solutions to common issues.
27-
The <a href="http://vimhelp.appspot.com/vim_faq.txt.html">Vim FAQ</a> is also useful.
28-
</p>
29-
3023
<h3>
31-
<a href="http://neovim.io/doc/user">User manual</a>
24+
<a href="http://neovim.io/doc/user">User documentation</a>
3225
</h3>
3326
<p>
34-
This is the online form of Nvim's <a href="http://neovim.io/doc/user/"><code>:help</code></a> system.
3527
<ul>
36-
<li>Neovim features are documented at <a href="https://neovim.io/doc/user/vim_diff.html#nvim-features"><code>:help nvim-features</code></a>.</li>
37-
<li><a href="http://neovim.io/doc/user/quickref.html"><code>:help quickref</code></a> is a handy cheatsheet.</li>
38-
<li>Read <a href="https://neovim.io/doc/user/nvim.html#nvim-from-vim"><code>:help nvim-from-vim</code></a> if you already use Vim.</li>
28+
<li>Neovim features: <a href="/doc/user/vim_diff.html#nvim-features"><code>:help nvim-features</code></a></li>
29+
<li>Read <a href="/doc/user/nvim.html#nvim-from-vim"><code>:help nvim-from-vim</code></a> if you already use Vim.</li>
30+
<li>Read about <a href="/doc/user/lua.html">Lua in Nvim</a></li>
31+
<li>Check the <a href="https://github.com/neovim/neovim/wiki/FAQ">FAQ</a>
32+
and <a href="https://github.com/neovim/neovim/wiki/Following-HEAD">breaking changes</a> for common issues.</li>
3933
</ul>
4034
</p>
35+
4136
</div>
4237
<div>
4338
<h2>Developer</h2>

doc2/lsp.html

Lines changed: 4 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -10,28 +10,9 @@
1010
<div class="container">
1111
<h1>Language Server Protocol Documentation</h1>
1212
</div>
13-
<div class="container golden-grid">
14-
<div>
15-
<h2>What is the Language Server Protocol ?</h2>
16-
<p>
17-
<a href="https://microsoft.github.io/language-server-protocol/">Language Server Protocol (LSP)</a> is an open, JSON-RPC-based protocol for communication between source code editors and language servers, which provide programming language-specific features such as:
18-
19-
<ul>
20-
<li>Go to definition</li>
21-
<li>(auto)completion</li>
22-
<li>Code Actions (automatic formatting, organize imports, ...)</li>
23-
<li>Show method signatures</li>
24-
<li>Show/go to references</li>
25-
<li>Snippets</li>
26-
</ul>
27-
</p>
28-
29-
<p>
30-
Starting with version 0.5, neovim natively supports this protocol.
31-
To enjoy these features, you need to install and configure a LSP server for the languages you are interested in.
32-
The neovim organization maintains a list of configurations in the <a href="https://github.com/neovim/nvim-lspconfig">nvim-lspconfig plugin</a>.
33-
The repository contains instructions to setup and troubleshoot many servers.
34-
</p>
35-
</div>
13+
<div class="container golden-grid">
14+
<p>
15+
This page was moved <a href="/doc">here</a>.
16+
</p>
3617
</div>
3718
</section>

doc2/lua-resources.html

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -10,19 +10,10 @@
1010
<div class="container">
1111
<h1>Lua resources</h1>
1212
</div>
13-
<div class="container golden-grid">
14-
<div>
15-
<h2>Where to look for lua guidance ?</h2>
16-
<p>
17-
Lua support improves with every release. Neovim 0.5 can for instance load its configuration from an init.lua instead of the traditional init.vim.
18-
The lua ecosystem around neovim is thrilling and so we list here a few resources to help you get started:
19-
<ul>
20-
<li>A <a href="https://github.com/nanotee/nvim-lua-guide">starting guide</a> for lua and neovim</a></li>
21-
</ul>
22-
23-
and of course the exhaustive `:help lua`.
24-
</p>
25-
</div>
13+
<div class="container golden-grid">
14+
<p>
15+
This page was moved <a href="/doc">here</a>.
16+
</p>
2617
</div>
2718
</section>
2819

doc2/treesitter.html

Lines changed: 4 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -10,21 +10,10 @@
1010
<div class="container">
1111
<h1>Tree-sitter documentation</h1>
1212
</div>
13-
<div class="container golden-grid">
14-
<div>
15-
<h2>What is tree-sitter ?</h2>
16-
<p>
17-
Neovim 0.5 adds experimental support for tree-sitter, a tool that serves as a parsing library. Parsing your code into a syntax tree allows for manipulating the structure of your code in a more intelligent way than is currently possible with regular expressions. This allows for improved (and faster):
18-
<ul>
19-
<li>syntax highlighting</li>
20-
<li>code navigation</li>
21-
<li>refactoring</li>
22-
<li>text objects and motions</li>
23-
</ul>
24-
See the tree-sitter <a href="https://tree-sitter.github.io/tree-sitter/">official website</a> for more details.
25-
The support is experimental but if you feel adventurous, you can use <a href="https://github.com/nvim-treesitter/nvim-treesitter">the following plugin</a> to install the language-specific tree-sitter grammars.
26-
</p>
27-
</div>
13+
<div class="container golden-grid">
14+
<p>
15+
This page was moved <a href="/doc">here</a>.
16+
</p>
2817
</div>
2918
</section>
3019

index.html

Lines changed: 14 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,14 +35,27 @@ <h3>Extensible</h3>
3535
<li>
3636
GUIs, IDEs, web browsers can <code>--embed</code> Neovim as an editor or script host.
3737
</li>
38+
<li>
39+
<a href="/doc/user/lua.html">Lua plugins</a> are easy to create just like Vimscript plugins.
40+
Your config can live in <code>init.lua</code>!
41+
</li>
42+
<li>
43+
AST-producing <a href="https://tree-sitter.github.io/">parsing engine</a>
44+
enables improved, faster syntax highlighting, code navigation,
45+
refactoring, text objects, and motions.
46+
</li>
3847
</ul>
3948

4049
<h3>Usable</h3>
4150
<ul>
51+
<li>
52+
Builtin <a href="/doc/user/lsp.html">LSP client</a> for
53+
semantic code inspection and refactoring (go-to definition, "find references", format, …)
54+
</li>
4255
<li>Strong <a href="/doc/user/vim_diff.html#nvim-defaults">defaults</a></li>
4356
<li>Works the same everywhere: one build-type, one command</li>
4457
<li>Modern terminal features such as cursor styling, focus events, bracketed paste</li>
45-
<li>Built-in <a href="https://www.youtube.com/watch?v=xZbMVj9XSUo">terminal emulator</a></li>
58+
<li>Builtin <a href="https://www.youtube.com/watch?v=xZbMVj9XSUo">terminal emulator</a></li>
4659
</ul>
4760

4861
<h3>Drop-in Vim</h3>

0 commit comments

Comments
 (0)