Skip to content

RetroAchievements website

RA discord server

Contributing with the docs

Summing up:

  1. Log into your github account (or create an account if you don't have one).
  2. Edit a page (or create a new one) on the RAwiki. You must use the Markdown markup language (more info below).
  3. Sooner or later a maintainer will generate the pages for RAdocs.

The difference between RAwiki and RAdocs is explained on the About page.

Markdownlink

Markdown is a lightweight and extremely easy to learn markup language with plain text formatting syntax. In order to contribute in our project you must know at least the basics of markdown. Here is a good one-page reference: http://commonmark.org/help/, and here you can try a 10 minutes tutorial.

Moreover, this wiki needs to be written in a certain format in order to convert cleanly to the pretty static pages. It's because we use mkdocs) and it uses python markdown and github uses github flavoured markdown, so there are some minor issues of formatting that will need to be addressed.

Headingslink

The headings (defined by #) should follow a natural progression of the hierarchy of the page contents. But you CANNOT have two title headings (those with only one # symbol). Otherwise they won't show up on the table of contents on the right side of the page

E.G.

# Title
## Main heading one
### Sub Heading one
### Sub heading two
## Main heading two

etc.

Links should follow this syntax

[Link](path to link)

Note: If it is a link to another wiki page it should be a relative path:

[Tips and Tricks](Tips-and-Tricks)

Do NOT use complete a full URL when linking to another wiki page, like this (yeah, this is an example of you should NOT do):

[Tips and Tricks](https://github.com/RetroAchievements/docs/wiki/Tips-and-Tricks)

Imageslink

Links to images should follow the same syntax as the example below:

![Image](http://url/a.png) 

Note:: In order to host images for this documentation project, you can post them in this issue thread here and use the github image hosting hack.

Tableslink

A simple table looks like this:

First Header | Second Header | Third Header
------------ | ------------- | ------------
Content Cell | Content Cell  | Content Cell
Content Cell | Content Cell  | Content Cell
Content Cell | Content Cell  | Content Cell

It should render like this:

First Header Second Header Third Header
Content Cell Content Cell Content Cell
Content Cell Content Cell Content Cell
Content Cell Content Cell Content Cell

You can specify alignment for each column by adding colons to separator lines:

First Header | Second Header | Third Header
:----------- |:-------------:| -----------:
Left         | Center        | Right
Left         | Center        | Right
Left         | Center        | Right

Results:

First Header Second Header Third Header
Left Center Right
Left Center Right
Left Center Right

Comments