-
Notifications
You must be signed in to change notification settings - Fork 28
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #6 from jasmineblinks/main
updated the content file
- Loading branch information
Showing
1 changed file
with
66 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,66 @@ | ||
+++ | ||
author = "Faith" | ||
title = "Introduction to Markdown " | ||
date = "2022-09-29" | ||
description = "Technical writing mentorship program fourth meetup" | ||
+++ | ||
|
||
Markdown is a lightweight markup language that can be used to format plaintext text documents. It was created by John Gruber in 2004, it is now one of the world’s most popular markup languages. | ||
|
||
Markdown is not the same as using a WYSIWYG editor. To format words in an application like Microsoft Word, you click buttons, and the changes are immediately visible. Markdown does not work like that. When you create a Markdown-formatted file, you use Markdown syntax to indicate which words and phrases should be formatted differently. | ||
|
||
## Benefits of using markdown | ||
|
||
- Markdown works on any platform. Markdown-formatted text can be created on any device running any operating system. | ||
- Markdown is timeless. Even if the application you're using stops working in the future, you'll be able to read your Markdown-formatted text with a text editing app. | ||
- Markdown can be used for just about anything. Websites, documents, notes, books, presentations, email messages, and technical documentation are all created with it. | ||
|
||
|
||
## How to create a markdown file | ||
|
||
- Use a text editor or a dedicated Markdown application to create a Markdown file. The file's extension should be.md or.markdown. | ||
- In a Markdown editor, open the Markdown file. | ||
- Convert the Markdown file to an HTML document using the Markdown application. | ||
- View the HTML file in a web browser or convert it to another file format, such as PDF, using the Markdown application. | ||
|
||
|
||
|
||
## Syntax for Markdown | ||
The syntaxes listed below can be used in writing markdown and are remarkably similar to those used in HTML. | ||
|
||
For headings, use: | ||
- # Heading level 1 | ||
- ## Heading level 2 | ||
- ### Heading level 3 | ||
- #### Heading level 4 | ||
- ##### Heading level 5 | ||
- ###### Heading level 6 | ||
|
||
For ordered list, use: | ||
1. First item | ||
2. Second item | ||
3. Third item | ||
4. Fourth item | ||
|
||
For unordered list, use: | ||
|
||
- First item | ||
- Second item | ||
- Third item | ||
- Fourth item | ||
|
||
or | ||
|
||
* First item | ||
* Second item | ||
* Third item | ||
* Fourth item | ||
|
||
For images, use: | ||
[![A beach](/assets/images/beach.jpg "beach, Maldives")](https://images.unsplash.com/photo-1602002418816-5c0aeef426aa?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=2874&q=80) | ||
|
||
|
||
## Resources | ||
- [John Gruber’s Markdown documentation](https://daringfireball.net/projects/markdown/) | ||
|
||
- [Markdown Tutorial](https://www.markdowntutorial.com/) |