neovim / neovim.github.io

Neovim website
https://neovim.io
MIT License
415 stars 100 forks source link

Doc: Autocmd section got messed up #319

Open kiyoon opened 1 year ago

kiyoon commented 1 year ago

Describe the bug

Selected part is messed up. They're part of the last bullet point but they (BufReadCmd, BufReadPre, BufUnload, BufWinEnter) should have their separate entries. There's also weird E200 and E201 which I don't know if they should exist.

image

Steps to reproduce

https://neovim.io/doc/user/autocmd.html

Expected behavior

BufReadCmd, BufReadPre, BufUnload, BufWinEnter should have their separate entries

Neovim version (nvim -v)

0.9.0

Vim (not Nvim) behaves the same?

no

Operating system/version

Ubuntu 22.04

Terminal name/version

wezterm 202211 stable

$TERM environment variable

xterm-256color

Installation

appimage

clason commented 1 year ago

That's an issue with https://github.com/neovim/tree-sitter-vimdoc, see the Readme:

nesting is ignored: indented listitems are parsed as siblings.

clason commented 1 year ago

(And the website has its own repo, where such issues are probably better discussed: https://github.com/neovim/neovim.github.io)

kiyoon commented 1 year ago

Thanks for moving the issue. I first uploaded this on https://github.com/neovim/doc but I wasn't sure where the problem is from.

clason commented 1 year ago

The issue is indeed the nested list, in particular the list item for BufRead ending with a nested list. Adding a new line afterwards fixes the issue (but messes up the layout of the help file, of course).