/gdx-wiki

Primary LanguageHTML

libGDX Wiki

This is a first draft of porting the libGDX Wiki to the main libGDX website (see libgdx/libgdx.github.io#58). It can be seen live at: https://crykn.github.io/

How does it work?

  • This repo is basically a fork of https://github.com/libgdx/libgdx.github.io
  • The wiki files were ported to Jekyll with the help of some code by Spaio
  • The website itself is a Jekyll blog that is deployed to GitHub Pages via GitHub Actions; see .github/workflows/github-pages.yml
  • The blog uses a modified version of the Minimal Mistakes theme; see _sass/wiki.scss; _layouts/default_wiki.html, _layouts/wiki.html

Ideas

  • Embedding GWT content, which would allow us to include actual executable libGDX examples directly in the wiki: the JS code should be located somewhere in /assets/wiki; then a <div> and the corresponding script (see the index.html generated by a libGDX GWT project) needs to be added to the wiki page; the GWT application itself requires some (asset) path changes. Later on, a custom embed-gwt element (see here for a very basic example of an element) should be created to simplify usage.