Including local documentation

[carsakiller]

Hello 👋,

I know we talked briefly in the wiki rework thread about providing local documentation for the language server. I have since written a little script that downloads the wiki and converts it into simple HTML files so that the wiki can be viewed locally completely offline.

I am not sure how we should go about including these as whenever the wiki is updated (with substantial enough changes), these static HTML files will have to be re-generated and included in the source code.

It would be nice if they could work in the same way that the official Lua documentation works:

I still have some more things to add to the downloadable wiki like a navigation bar and improved CSS but I should soon have a good candidate for including in the source code.

[carsakiller]

This is what I was able to come up with:

it also has an automatic dark mode:

[carsakiller]

Well, it is pretty much done, just trying to think of a good way to include it for the language server. A submodule could work and would allow me to update it frequently without needing to open a PR here... but it also requires me to commit the generated files every time and then it would have to be re-pulled from this repo.

Any ideas?

[sumneko]

Maybe includes local documentation in building?

[carsakiller]

Ok, so I am not very familiar with GitHub's actions stuff... but these steps seem pretty logical:

1. I could run an action to execute my script and create a release in my repo that contains a zip (that always has the same name) of all the documentation files
2. This repo would use a release asset fetching action to get the asset from my release where it would then need to be unzipped

[carsakiller]

The generated documentation files (doc.zip) can be found in my releases.