Skip to content

Instantly share code, notes, and snippets.

@palkerecsenyi
Last active April 2, 2021 11:34
Show Gist options
  • Save palkerecsenyi/da735ae03c11909931706fefebc4fbbc to your computer and use it in GitHub Desktop.
Save palkerecsenyi/da735ae03c11909931706fefebc4fbbc to your computer and use it in GitHub Desktop.
A super quick intro to Markdown for MyMGS admins

Markdown

We've all used Microsoft Word at some point. If you've ever wanted to format text a certain way (that is, make it bold, italic, big, small, etc.), Word will have had a button to do it for you.

However, you need to download Word if you want to edit a Word document — what you create doesn't really work with any other software. Plus, information about formatting isn't contained inside your text itself, but instead is stored in a complex metadata section of your DOCX file.

Markdown makes it easier to format text without an advanced text editor, in a way that works across all platforms. You make some tiny changes to your text, and the MyMGS app will render these for you. Plus, we'll take care of making sure your text is accessible and compatible with Dark Mode — all you have to do is write the text.

Example

In your Markdown editor, you can use the following basic tricks to format your text:

# Big heading
## Slightly big heading
### Smaller heading

**bold text**

_italicised text_

*also italicised text*

these pieces of text
 are on the same line
 
these pieces of text

are on separate lines

Big heading

Slightly big heading

Smaller heading

bold text

italicised text

also italicised text

these pieces of text are on the same line

these pieces of text

are on separate lines

Find out more

This document explains more about Markdown, including how to add more advanced elements (e.g. images and tables).

You can also use this website for an interactive Markdown experience.

If you're still not convinced, you can also write formatted text in Microsoft Word and use this plugin to convert your text.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment