{"id":20484202,"url":"https://github.com/khaledsalshibani/markdown-tutorial","last_synced_at":"2025-03-05T16:18:45.771Z","repository":{"id":229855034,"uuid":"769472337","full_name":"khaledsAlshibani/markdown-tutorial","owner":"khaledsAlshibani","description":"A simple guide to learn Markdown with examples.","archived":false,"fork":false,"pushed_at":"2024-03-26T19:24:58.000Z","size":73,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-01-16T04:26:07.539Z","etag":null,"topics":["guide","markdown","tutorial"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/khaledsAlshibani.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-03-09T07:02:51.000Z","updated_at":"2024-03-27T12:54:59.000Z","dependencies_parsed_at":"2024-11-15T16:33:16.104Z","dependency_job_id":null,"html_url":"https://github.com/khaledsAlshibani/markdown-tutorial","commit_stats":null,"previous_names":["khaledsalshibani/markdown-tutorial"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaledsAlshibani%2Fmarkdown-tutorial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaledsAlshibani%2Fmarkdown-tutorial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaledsAlshibani%2Fmarkdown-tutorial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/khaledsAlshibani%2Fmarkdown-tutorial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/khaledsAlshibani","download_url":"https://codeload.github.com/khaledsAlshibani/markdown-tutorial/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":242058218,"owners_count":20065066,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["guide","markdown","tutorial"],"created_at":"2024-11-15T16:20:26.294Z","updated_at":"2025-03-05T16:18:45.742Z","avatar_url":"https://github.com/khaledsAlshibani.png","language":null,"readme":"\u003ch1\u003eMarkdown Tutorial\u003c/h1\u003e\nThis tutorial will help you understand the basics of writing in Markdown with examples.\n\n### Table of Contents:\n\n---\n\n- [What is Markdown](#what-is-markdown)\n- [How to](#how-to)\n  - [Creating Headings](#creating-headings)\n  - [Writing Normal and Plain Text](#writing-normal-and-plain-text)\n  - [Formatting Text with Italic and Bold](#formatting-text-with-italic-and-bold)\n  - [Making Lists](#making-lists)\n  - [Creating a Divider](#creating-a-divider)\n  - [Writing Inline Code and Code Blocks](#writing-inline-code-and-code-blocks)\n  - [Creating Tables](#creating-tables)\n  - [Blockquotes](#blockquotes)\n- [Markdown Preview in VS Code](#markdown-preview-in-vs-code)\n- [Best Markdown Plugins in VS Code](#best-markdown-plugins-in-vs-code)\n\n---\n\n## What is Markdown\n\n\u003e Markdown is a **lightweight markup language** that you can use to add formatting elements to plain text documents. Created by John Gruber in 2004, Markdown has become one of the world’s most popular markup languages.\n\u003e ([Markdown Guide](https://www.markdownguide.org/getting-started/))\n\n**Markdown** can be used in various contexts to format text for the web. It is commonly used in **README** files, known for its simplicity and readability.\n\n---\n\n## How to\n\n### Creating Headings\n\nUse `#` symbols before your text to create headings. One `#` for `h1`, two `##` for `h2`, etc., with a space following the symbols.\n\n**Examples:**\n- ### This is an h3 heading created by writing `### This is an h3 heading created by ...`\n- #### This is an h4 heading created by writing `#### This is an h4 heading created by ...`\n- ##### This is an h5 heading created by writing `##### This is an h5 heading created by ...`\n\n---\n\n### Writing Normal and Plain Text\n\nSimply type to add normal text without any special formatting.\n\n---\n\n### Formatting Text with Italic and Bold\n\n- **bold**: write two asterisks before and after the word or sentence as `**bold**`.\n- *italic*: write one asterisk before and after the word or sentence as `*italic*`.\n\n---\n\n### Making Lists\n\nYou can create both ordered and unordered lists.\n\n1. **Unordered Lists**\n\n    At the beginning of the line, use an asterisk (`*`), plus symbol (`+`), or hyphen (`-`).\n    \n    Example:\n    \n    ```markdown\n    - list item\n      - subitem\n    ```\n\n2. **Ordered Lists**\n\n    Number each item.\n    \n    Example:\n    \n    ```markdown\n    1. list item\n    2. list item 2\n      1. subitem\n    ```\n\n**Note:**\n\n- Start a new line for each list item.\n- Add a space after the list marker.\n\n---\n\n### Creating a Divider\n\nUse three dashes `---`, three underscores `___`, or three asterisks `***` to create a divider like the one above.\n\n---\n\n### Writing Inline Code and Code Blocks\n\n1. Inline code:\n   Use single backticks ` `` ` around the code. For example, `This is inline code` and here’s how to write it: ``cout \u003c\u003c \"Hello World!\";``\n\n2. Code Blocks\n   To write a code block, use three backticks ``` before and after the code snippet. To specify the language, write it next to the first set of three backticks.\n\n   **Example:**\n\n   ![Code Block Example](./assets/code-block.png)\n\n   **Output:**\n\n   ```cpp\n   int x = 0;\n   int y = 1;\n   cout \u003c\u003c x + y;\n   ```\n\n---\n\n### Creating Tables\n\nI prefer using an online generator or a plugin like **Markdown Table Maker**. At all tables are created using vertical bars `|` and hyphens `-` for headings.\n\n---\n\n### Blockquotes\n\nFor blockquotes, simply add a `\u003e` at the start of the line.\n\n\u003e Hi, I am a blockquote made by this:\n\u003e `\u003e Hi, I am a blockquote made by this ...`\n\n---\n\n## Markdown Preview in VS Code\n\nTo view the output or result, press `Ctrl + Shift + V`, or click the **Open Preview** icon in the top right.\n\n## Best Markdown Plugins in VS Code\n\n- Markdown All in One - *By: Yu Zhang*\n- Markdown PDF - *By: yzane*\n- Learn Markdown - *By: Microsoft*\n- Markdown Table Maker - *By: hellorusk*","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhaledsalshibani%2Fmarkdown-tutorial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkhaledsalshibani%2Fmarkdown-tutorial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkhaledsalshibani%2Fmarkdown-tutorial/lists"}