Skip to content

Markdown basics

Martin Shetty edited this page Apr 13, 2021 · 1 revision

We use a simple formatting language called Markdown to efficiently edit and format documentation files.

Learning Markdown:

Linking to other files in the repository:

  • Any time we have a link to a file or directory in GitHub, we should use relative links.
  • If the file or directory you're linking to lives in the same directory as the file you're currently editing, you can strip out everything except for the directory or file name.
    • Example: If we were editing a document inside the ventilator-design directory in the repository and wanted to add a link to a file in that same directory, we would do [read more here](conop.md) instead of [read more here](https://github.com/RespiraWorks/SystemDesign/blob/master/ventilator-design/conop.md .
  • If you need to link to a file or directory in a different parent directory than the one you're currently in, you can use .. to tell GitHub to "go up one directory" and then use a relative path to the directory or file you're trying to link to.
    • Example: If you were editing a document inside of the ventilator-design folder and wanted to add a link to a directory that lives in a different parent directory, we'd do see [here](../research-development/project-pinch-valve) instead of see here`. This tells GitHub, "go up one level to the root directory, then go to to the research-development folder and link to the project-pinch-valve folder."