Skip to content

๐Ÿ“š Guidelines

You need to follow these rules in order to contribute to the docs. They are important for a good user experience and provide a consistent baseline for other contributors to work with.

Internal๐Ÿ”—

Links to internal pages can be opened in the same tab. This works with the normal markdown link syntax:

1
Click the [highlighted words](Contributing.md).
Result: Click the highlighted words.

External๐Ÿ”—

Links to external sites must be opened in new tabs using this html code:

1
<a href="https://betonquest.org/" target="_blank">Clickable text that opens a new tab</a>
Result: Clickable text that opens a new tab

Displaying (YAML) code๐Ÿ”—

You must use codeboxes with the specific language set in the header (YAML in this example). You also have to enable line numbers by adding the linenums="1" argument.

1
2
3
 ``` YAML linenums="1"
 use: "codeboxes for code"
 ```

Result:

1
use: "codeboxes for code"

Refering to YAML elements in written text๐Ÿ”—

An example of this would be to reference an event name in an explanation.

1
The event `someEvent` prints a message to the player!

Result: The event someEvent prints a message to the player!

File names๐Ÿ”—

Replace all spaces in file and folder names with -!

Lists๐Ÿ”—

Lists must be declared as such:

* Top Level
    - Second Level
    - Second Level
* Another Top level

Result:

  • Top Level
    • Second Level
    • Second Level
  • Another Top level

Line length๐Ÿ”—

A single line may only have 170 characters. Please wrap at 121 though.


Last update:
Back to top