Skip to content
This repository has been archived by the owner on Feb 3, 2023. It is now read-only.

Markdown Tips and Guidelines

Maximilian Ehrhardt edited this page Jan 24, 2021 · 3 revisions

Testing

Sometime experimenting with code, html, etc is needed. Copy paste your snipped into the wiki and check the preview there instead of commiting and pushing every time.

Hidden Comment

Use the following syntax: <!-- TODO: Add a picture of the tablet GUI -->

To make it look like this:

Refer to File or Path

Use the following syntax to refer to files and paths:

*`ExoMy/ExoMy Release vx.x.x/BoM/PI_ExoMy_Purchasing_BoM.xlsx`*

To make it look like this: ExoMy/ExoMy Release vx.x.x/BoM/PI_ExoMy_Purchasing_BoM.xlsx

Refer to Section

Be aware that this methods does NOT work in the preview. It does however work on the deployed wiki. GitHub wiki does NOT care about folders. So the text file can be in a folder or not, it always has to referenced JUST by it's name.

This links to a subsection... This also links to a subsection...

This links to a page... And so does this.

Embed an image the right way

Use a / in front of the link to make it absolute in regards to the .md file. Use a line brake above the included image as the image appears next to the text.

In this case the formating is fine. In this case the formating is fine. In this case the formating is fine. In this case the formating is fine oh so fine, so fine.

Include a picture and change its width

Enumerate titles

This tool might break the section references mentioned above! (Use https://github.com/A4Vision/enumerate-markdown to enumerate titles at the end.)

Include PDF

NOT WORKING IN GITHUB WIKI

This browser does not support PDFs. Please download the PDF to view it: Download PDF.

This browser does not support PDFs. Please download the PDF to view it: Download PDF.