neovim / doc

Generated documentation and reports
neovim.github.io/doc/
Apache License 2.0
31 stars 13 forks source link

user-docu: generate HTML docs using treesitter #27

Closed justinmk closed 1 year ago

justinmk commented 2 years ago

Problem:

The HTML :help docs generated by the old doc_html task (which is driven by an old awk script runtime/doc/makehtml.awk). Besides being hard to maintain (ad hoc parser and no one has touched it in decades), it has bugs like:

Solution:

Use the gen_help_html.lua script from https://github.com/neovim/neovim/pull/11967

There are some regressions, so currently this generates to a new temporary user2/ path so that people can try it out.

justinmk commented 1 year ago

@jamessan this PR also enables CI (except the "Push update" job) for pull requests : https://github.com/neovim/doc/pull/27/commits/1a1a2ec5e400866cd9da21d97066a2c6cb040e10

justinmk commented 1 year ago
2022-09-22T14:16:34.4934211Z E5108: Error executing lua vim/_init_packages.lua:0: module 'vim.fs' not found: