search

func-godot / func_godot_docs

Documentation for the FuncGodot plugin.
MIT License
4 stars 4 forks source link

Move docs to Jekyll #5

Closed iBoonie closed 2 months ago

iBoonie commented 2 months ago

Move docs to Jekyll Actions, merging all pages via includes for easy searching. Adds Anchor links so one can link to specific sections #3

I know its a huge change, so hopefully this is fine.

RhapsodyInGeek commented 2 months ago

I intentionally avoided a big long one page manual because I did not want all content to be on a single page. There's the psychological effect of making it feel more digestible when you see that there's an end to the section you're on, like chapters in a book.

Additionally, while it may seem excessive, the purpose of the FuncGodotManual.html page being separate from the index.html and index.html only redirecting to the FuncGodotManual.html was for clearer local offline viewing. The simple nature of the pure HTML5 and CSS design was to make it easily portable and viewable locally. This PR makes the docs no longer work locally.

I do agree that it's a problem that you can't link to individual pages currently, and I'm open to solutions so long as they can keep the pages separately viewable and maintain offline local viewing functionality. Unfortunately, this PR is not the solution for that. Your hard work is appreciated though! I'm sorry we can't use it as is.