From 98f5a55ae14a16d79a391a6efa7cb9c80ce0861f Mon Sep 17 00:00:00 2001 From: jasmineblinks Date: Thu, 29 Sep 2022 16:25:23 +0100 Subject: [PATCH] updated the content file --- content/post/introduction-to-markdown.md | 45 ++++++++++++++---------- 1 file changed, 26 insertions(+), 19 deletions(-) diff --git a/content/post/introduction-to-markdown.md b/content/post/introduction-to-markdown.md index cf82071..69267bb 100644 --- a/content/post/introduction-to-markdown.md +++ b/content/post/introduction-to-markdown.md @@ -7,7 +7,7 @@ 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. +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 @@ -15,7 +15,6 @@ Markdown is a lightweight markup language that can be used to format plaintext t - 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. @@ -23,44 +22,52 @@ Markdown is a lightweight markup language that can be used to format plaintext t - 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 + +- # Heading level 1 ('# Heading level 1') +- ## Heading level 2 ('## Heading level 2') +- ### Heading level 3 ('### Heading level 3') +- #### Heading level 4 ('#### Heading level 4') +- ##### Heading level 5 ('##### Heading level 5') +- ###### Heading level 6 ('###### Heading level 1') For ordered list, use: -1. First item + +1. First item (1. First item) 2. Second item 3. Third item 4. Fourth item For unordered list, use: -- First item +- First item (- first item) - Second item - Third item - Fourth item -or +or -* First item -* Second item -* Third item -* Fourth item +- 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) +(![Maldives Beach](https://images.unsplash.com/photo-1602002418816-5c0aeef426aa?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=2874&q=80)) +![Maldives Beach](https://images.unsplash.com/photo-1602002418816-5c0aeef426aa?ixlib=rb-1.2.1&ixid=MnwxMjA3fDB8MHxwaG90by1wYWdlfHx8fGVufDB8fHx8&auto=format&fit=crop&w=2874&q=80) + +For links, use: +([Markdown Tutorial](https://www.markdowntutorial.com/)) + +[A link example](https://www.markdowntutorial.com/) ## Resources + - [John Gruber’s Markdown documentation](https://daringfireball.net/projects/markdown/) -- [Markdown Tutorial](https://www.markdowntutorial.com/) \ No newline at end of file +- [Markdown Tutorial](https://www.markdowntutorial.com/)