Text files are great for documentation, but sometimes we want rich formatting such as headers, URLs, images and more. One option is to write in HTML, but it can take time to learn and not everyone can read HTML. Another option is to use Word or a PDF document, but those are harder to change and require external software. We need something in between - like a text file but with extra formatting that isn't too difficult to learn.
Markdown is a lightweight markup language that uses simple syntax for styling text files. It stands in the middle between a text file and a HTML file. It is simple to learn and very powerful to use.
Here is an example of a markdown format with its output:
Markdown:
# Readme
## How to start
1. Turn on engines
2. Press the **red** button
3. Hold tight
## Support
To get support, go to [this URL](<http://support.example.org>)
Output:
The official VSCode youtube channel has created this video to tell you more about Markdown:
https://youtu.be/Hgucu1ch3mo?si=sPgXqFcCvPvdzpww
<aside> ❗
Avoid using the mentioned GitDoc extension if you have a repository with code. As developers, we don't want automatic commits.
</aside>
You may have already noticed that GitHub README files use Markdown syntax.
Check out this great guide for markdown to learn more:
https://www.markdownguide.org/basic-syntax/
Save or Bookmark this cheatsheet for a quick Markdown reference
https://www.markdownguide.org/cheat-sheet/
The HackYourFuture curriculum is licensed under CC BY-NC-SA 4.0 **
