![]() If you have any problems, PLEASE contact with your wishlist (hopefully something like “please make github wikis better! $IDEAS”). Github does NOT have a robust pull request system for wiki changes, so this is the way it is for non-trivial changes to the wiki. Message a libGDX maintainer (who has commit rights) on our Discord to clone your repo and push it themselves.Commit and push that to your forked repo.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: Github’s web interface is the only way that a non-contributor can easily edit a wiki. Images are linked to with the following syntax (assuming the image is stored in the images/ directory) ] (without the spaces in between brackets) which will display: To add an image, you must clone the repo: $ git clone 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 stored in the images/ of the libGDX wiki, which arent accessed through the libGDX wikis github interface. Images need to be added manually through a desktop interface (A.K.A. Please see the box2d article for more information. So when we go to make our table of contents, it would be in an unordered list, and using these qualified page fragment links. 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 When creating headers in markdown, we specify using a number of octothorpes ( #) that define the header level. For an example of how to do so outside of this section, please refer to our box2d article. Tables of contents have to be manually created on a per-page basis. 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. This is to signify that during translation from Google Code wiki to Github Wiki, there were a couple of pages without links. The Table of contents contains a few pages that do not have a link, and are appended with a ?. Mirror this change in the sidebar ToC, as to maintain likeness between the two. When you create an article, please create a second edit of the Home page with the appropriate positioning of your article. 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. Lets hope Github eventually supports embedded videos! The Main Table Of Contents 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. Without the escaped paren, a 404 is imminent! Videos When using the markdown formatting of () the end paren will mess up the link, so please remember to escape the ending paren ( )) so for example, it should be : http : ///nightlies/docs/api/com/badlogic/gdx/graphics/Texture.html#getWidth().If a link to documentation ends in a right paren ), it will mess up the markdown. ![]() Please make the format ClassName (Code) with the word Code, not Source or any derivative of that.Please note that there should be a space in between ClassName (Code) style formatting, in order to differentiate the two.( https : ///libgdx/libgdx/tree/master/gdx/src/com/badlogic/gdx/graphics/Texture.java)ĭon’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 “:”). ![]() ( http : ///nightlies/docs/api/com/badlogic/gdx/graphics/Texture.html).Links are done as follows: (link to docs) (link to code) for example: ] renders this: link text to simple gameĭo NOT use conventional () syntax for wiki-links. Wiki links are made using ] (without the spaces) with a | (pipe) to separate text from link.To learn your way around this, here is the official Markdown Cheatsheet. ![]() If you have any questions about how to edit this wiki, please do not hesitate to ask! See our Discord for more information. Please read this before contributing to the libGDX wiki. This page is a notice on how to edit libGDX wiki pages. ![]()
0 Comments
Leave a Reply. |
AuthorWrite something about yourself. No need to be fancy, just an overview. ArchivesCategories |