GitHub Markdown Reference

---

References

• This is a quick, non-exclusive GitHub Markdown syntax guide. More details can be found in the original GitHub Docs : Writing on GitHub

---

Comments

To add a comment inside of the markdown file, that will not be rendered in the final HTML, use the following syntax:

[//]: # (This is a comment.)

Relative links

When the link starts with a /, it is relative to the root of the repository (regardless of whether the markdown file is nested in subdirectories).

[read me](/README.md)

The final link structure will be https://github.com/{user}/{repo}/blob/{branch}/{path}/{to}/{file}/{file}

[index](/path/to/file/README.md)

Dropdown

How do I dropdown? (closed dropdown)

This is how you dropdown.

<details>
<summary>How do I dropdown?</summary>
<br>
This is how you dropdown.
</details>

---

Want to ruin the surprise? (opened dropdown)

Well, you asked for it!

<details open>
<summary>Want to ruin the surprise?</summary>
<br>
Well, you asked for it!
</details>