Hello, I am Anas Abuelhaag, a Microsoft Student Ambassador from Egypt, currently pursuing a degree in Software Engineering.
Imagine you've written a code that prints "hello world."
Next, you decide to upload it onto GitHub, To showcase your work, but hold on a sec, before you commit, Markdown is here to make writing. Markdown makes writing you documentation a joy, a breeze.
Markdown makes your projects clear and bright, it make it accessible, professional, markdown's the tool that's perfect for you.
First, you need a place to write Markdown. I'm using VS Code. There are many editors for Markdown; use this link to explore more options. If you're using VS Code, just add the extension ".md" to your file, and to see the preview, simply press "Ctrl+Shift+V".
To write a paragraph, just start typing. It's as simple as that!
For headings, you simply use the '#' symbol. You can create up to six levels of headings. For each level, add another '#'. For example, for a level 5 heading, use '#####'. Hope it's easy till now!
Here are some examples:
Now, let's learn about bold, italic, and strikethrough.
__word__
or asterisks: **word**
.*word*
or _word_
.~~word~~
.Assuming you are a programmer, you will likely need to add some code snippets to your README file on GitHub. This is easy to do with Markdown. Just use triple backticks to enclose your code:
print('Markdown is awesome')
Easy, right? Just use triple backticks, and your code will be displayed perfectly. Whether you're sharing Python, JavaScript, or any other language, Markdown has got you covered.
Markdown also makes it easy to create lists, which are useful for organizing information. There are two types of lists you can create: unordered lists and ordered lists.
Unordered lists are created using dashes (-
), plus signs (+
), or asterisks (*
). All three symbols are interchangeable. Each item in the list should be on its own line, starting with one of these symbols, followed by a space.
Example:
Ordered lists are created using numbers followed by a period. The numbers don't have to be in order when you write them; Markdown will render them sequentially.
Example:
You can also create nested lists by indenting items under a list item. Use two spaces or a tab to indent.
Example:
We can dive even deeper with tables. This requires a bit more setup than the other elements, but it's still straightforward. Here's how you can create a table in Markdown:
Header 1 | Header 2 | Header 3 |
---|---|---|
Row 1, Col 1 | Row 1, Col 2 | Row 1, Col 3 |
Row 2, Col 1 | Row 2, Col 2 | Row 2, Col 3 |
To create a table:
|
to separate columns.---
to separate the header from the rows.:
on either side of the dashes if needed (for left, right, or center alignment).These were the essentials to use Markdown language. Of course, there are more and more options, but I think we've covered all you need to learn to write anything you want using Markdown. To learn more, you can use the following resources:
So dive into Markdown, give it a try, It's simple, it's fun, and you'll soar high!
You must be a registered user to add a comment. If you've already registered, sign in. Otherwise, register and sign in.