Add wiki pages to the libGDX website #65
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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!
[[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./assets/wiki/
._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
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 theafter_footer_scripts
; the unminified code can be found here).Future Ideas
/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 customembed-gwt
element (see here for a very basic example of an element) should be created to simplify usage.