HTML Help Generation

[alex-courtis]

luals appears to be able to generate HTML, as does Nvim.

[alex-courtis]

Nvim html generation works:

nvim -V1 -es --clean +"lua require('src.gen.gen_help_html').gen('./runtime/doc', 'target/dir/')" +q

It's missing styles, as it needs the plumbing from https://neovim.io/doc

It's possible.

nvim-tree-lua.html help.css

[alex-courtis]

Adding URLs for styles e.g. https://neovim.io/css/main.css works.

The Nvim logo and search box still appear, which is not acceptable. They can be removed by deleting the nav navbar navbar-expand-lg

nvim-tree-lua.html

help.css

I'm not sure how practical this is; we'd need to set up a hosting site and deploy via CI.

Edit: it looks like we can source all the css/js from https://github.com/neovim/neovim.github.io it doesn't have tags, however should be Good Enough.

[alex-courtis]

luals generates markdown that's not particularly useful and it's obviously only classes/functions, no @brief, other doc etc.

---

nvim_tree.config.actions.open_file.window_picker

chars

string?

Identifier characters to use.
(default: "ABCDEFGHIJKLMNOPQRSTUVWXYZ1234567890")

enable

boolean?

(default: true)

exclude

(nvim_tree.config.actions.open_file.window_picker.exclude)?

[nvim_tree.config.actions.open_file.window_picker.exclude]

picker

("default"|fun():integer)?

Change the default window picker or define your own.
(default: "default")

---

[gegoune]

I'm not sure how practical this is; we'd need to set up a hosting site and deploy via CI.

Shouldn't be difficult with GitHub hosting option.

[alex-courtis]

I'm not sure how practical this is; we'd need to set up a hosting site and deploy via CI.

Shouldn't be difficult with GitHub hosting option.

Nice... I'm game if you are.

The help doc is a work in progress, closer to completed. Once that's locked down for all the cases we can add the html plumbing.

• Documentation: Config luals Annotations And Help #2934
• Documentation: API luals Annotations And Help #3088
• Documentation: Decorator luals Annotations And Help #3241
• Documentation: Renderer.HiddenDisplay luals Annotations And Help #3243

Could we do something like add the publishing to the release CI steps?