How to write correctly in Github

mgp25 edited this page Oct 6, 2015 · 4 revisions

This guide will help you in how to write correctly in Github:

Posting code:

```php
$a = "Hola!";
echo $a;
// Without the brackets below!
[```]

Result:

$a = "Hola!";
echo $a;

Posting nodes:

[```xml]
tx  <presence type="subscribe" to="34*********@s.whatsapp.net"></presence>
rx  <presence from="34*********@s.whatsapp.net"></presence>
// Without the above and below brackets!
[```]

Result:

tx  <presence type="subscribe" to="34*********@s.whatsapp.net"></presence>
rx  <presence from="34*********@s.whatsapp.net"></presence>

Posting errors/quotes:

[```]
This is a quote/error
// Without the above and below brackets!
[```]

Result:

This is a quote/error

Text formatting:

Bold

**Bold text**

Result:

Bold text

Italic

_Italic text_

Result:

Italic text

Mistaken text

~~Mistake text~~

Result:

Mistake text

Doing lists

**My List:**
- This guide is so cool
- Welcome to WhatsAPI Official
- Other things

Result:

My List:

  • This guide is so cool
  • Welcome to WhatsAPI Official
  • Other things

Posting images:

![tag](url of the image)

Result:

tag

You can’t perform that action at this time.
You signed in with another tab or window. Reload to refresh your session. You signed out in another tab or window. Reload to refresh your session.
Press h to open a hovercard with more details.