Skip to content

GitHub Markdown Reference

Jump to bottom
dMLTquant edited this page Sep 7, 2021 · 4 revisions
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

To add a dropdown the <details><summary> syntax is needed. Although it works with only <details> it is common practice to use <summary> to provide a title. Use <details close> or <details open> to define the state of the dropdown (default is close).

<details><summary>This is the title</summary>

Markdown or <HTML> content

</details>
Clone this wiki locally