Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add wiki pages to the libGDX website #65

Merged
merged 3 commits into from
Jan 12, 2022
Merged

Add wiki pages to the libGDX website #65

merged 3 commits into from
Jan 12, 2022

Conversation

crykn
Copy link
Member

@crykn crykn commented Jan 12, 2022

This PR ports the libGDX wiki to the libGDX website. The main reasoning behind this is that GitHub wikis are no longer indexed by search engines, making the wiki far less useful.

Closes #58. Closes #62. See Status Report #8.

How does it work?

The old wiki markdown files were ported to Jekyll with the help of some code by @Spaio. Thank you very much for this!

  • The main step involved was fixing the wiki-style links ([[streaming-music]] -> [streaming-music](wiki/audio/streaming-music.md)) and, in the course of this, organising the pages in subdirectories to make them more manageable.
  • Similarly, the paths of assets located in the old wiki repo were changed to refer to their new location in /assets/wiki/.
  • In addition, every wiki page now needs a frontmatter specifying a page title:
    ---
    title: Modules overview
    ---
  • The wiki pages are now available via the /wiki/ subsection of the website which uses a modified version of the Minimal Mistakes theme; see _sass/wiki.scss; _layouts/default_wiki.html, _layouts/wiki.html; the ToCs can be found at _includes/wiki_index.md and _includes/wiki_sidebar.md
  • Previous progress on this project can be seen here. The old wiki is still accessible via the history.

For anyone stumbling upon this PR later on, since then we've done a couple of changes to the files seen in this PR. We've also recently introduced a simple search feature for wiki pages (wiki/search.md, _includes/wiki_masthead.html) which uses Lunr to index the full page content of the wiki pages, and we added a custom "copy to clipboard" action (assets/js/clipboard.js; added to the after_footer_scripts; the unminified code can be found here).

Future Ideas

  • Embedding GWT content (Embed GWT apps #68), 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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Canonical links should be absolute Mirror/Move the current libGDX wiki to GitHub Pages?
1 participant