This page is a notice on how to edit libGDX wiki pages. Please read this before contributing to the libGDX wiki.

Questions

Discord for more information.

Style

Markdown Cheatsheet.

Notable syntax

• [ [ and ] ] (without the spaces) with a | (pipe) to separate text from link. For example: [[link text to simple game | A simple game]] renders this: link text to simple game

Linking to code/docs

[ClassName](link to docs) [(code)](link to code) for example:

[Texture](http://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/graphics/Texture.html)[(code)](https://github.com/libgdx/libgdx/tree/master/gdx/src/com/badlogic/gdx/graphics/Texture.java)

renders the following: Texture (code) Don’t use non-alphabetic characters in Wiki page names, because not all operating systems can handle them when cloning Wiki as Git repository (for example, Windows doesn’t support “:”).

Notes on Doc Links

• ClassName (Code) style formatting, in order to differentiate the two.
• ClassName (Code) with the word Code, not Source or any derivative of that. Consistency is key!
• ), it will mess up the markdown. take this as an example:

  http://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/graphics/Texture.html#getWidth()

  []() the end paren will mess up the link, so please remember to escape the ending paren ()) so for example, it should be :

  [Link to Texture#getWidth](http://libgdx.badlogicgames.com/nightlies/docs/api/com/badlogic/gdx/graphics/Texture.html#getWidth(\))

  without the escaped paren, a 404 is imminent!

  Videos

  Videos are not supported on GitHub :( so we use a small workaround by posting a screenshot of the video, which leads to a link to the youtube video. Here is the syntax:

  <a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE_VIDEO_ID_HERE" target="_blank"><img src="http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg"alt="IMAGE ALT TEXT HERE" width="480" height="360" border="10" /></a>

  Lets hope Github eventually supports embedded videos!

  The Main Table Of Contents

  If you make a page, you will most likely want it to be displayed on the main libGDX wiki Table of contents and the sidebar Table of Contents. When you create an article, please create a second edit of the Home page with the appropriate positioning of your article. Mirror this change in the sidebar ToC, as to maintain likeness between the two.

  Non pages on the Table of Contents

  ??. This is to signify that during translation from Google Code wiki to Github Wiki, there were a couple of pages without links. If you have something to contribute on the topic of one of those pages without a page (yet!), please feel free to add a page, and add your content, then reflect your changes in the ToC by adding a link.

  Tables of Contents per page

  box2d article. #) that define the header level. When we create a header ## Comments and Questions/Concerns ## in an article entitled Help Me the corresponding link would be help-me#comments-and-questionsconcerns box2d article for more information.

  Adding Images

  images/ of the libGDX wiki, which arent accessed through the libGDX wikis github interface. To add an image, you must clone the repo: $ git clone https://github.com/libgdx/libgdx.wiki.git add your images to the images folder using the appropriate naming scheme my-page-name# where # is the order of the picture displayed on the page (this can be ommitted if only one image is used in the page, but recommended). Images are linked to with the following syntax (assuming the image is stored in the images/ directory) [ [images/using-libgdx-with-intellij-idea01.png] ] (without the spaces in between brackets) which will display:

  Large Multi-Page Edits

  Github’s web interface is the only way that a non-contributor can easily edit a wiki. If a person is to make a large edit that spans multiple pages, it can be done via the web interface, but it is recommended to take the following steps:
• Discord to clone your repo and push it themselves. PLEASE contact support@github.com with your wishlist (hopefully something like “please make github wikis better! $IDEAS”). If you have a problem, it is necessary that you voice yourself to Github!

  Small Typo Fixes

  Github wiki’s diff system is not as robust as the diff system for code. If you make a tiny change, in the commit message please say “Fixed typo alpa -> alpha” or something of the sort.