{"id":25424719,"url":"https://github.com/asmitranjansinha/markdown-guide","last_synced_at":"2025-07-14T17:41:02.230Z","repository":{"id":162249003,"uuid":"618254229","full_name":"asmitranjansinha/markdown-guide","owner":"asmitranjansinha","description":"📝 This is my ultimate guide to Markdown readme. Feel free to contribute and add more content to this guide!","archived":false,"fork":false,"pushed_at":"2025-02-07T14:16:45.000Z","size":7,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-02-07T15:24:25.876Z","etag":null,"topics":["guide","markdown","markdown-guide"],"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/asmitranjansinha.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":"2023-03-24T04:19:21.000Z","updated_at":"2025-02-07T14:19:01.000Z","dependencies_parsed_at":null,"dependency_job_id":"540a2a0d-9720-4715-baaa-f0806c6a7b52","html_url":"https://github.com/asmitranjansinha/markdown-guide","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmitranjansinha%2Fmarkdown-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmitranjansinha%2Fmarkdown-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmitranjansinha%2Fmarkdown-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/asmitranjansinha%2Fmarkdown-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/asmitranjansinha","download_url":"https://codeload.github.com/asmitranjansinha/markdown-guide/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":239207394,"owners_count":19599966,"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","markdown-guide"],"created_at":"2025-02-16T23:17:26.681Z","updated_at":"2025-02-16T23:17:27.275Z","avatar_url":"https://github.com/asmitranjansinha.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# What is Markdown?\n\n_**Markdown** is a plain text formatting syntax for writers. It allows you to quickly write structured content for the web, and have it seamlessly converted to clean, structured HTML._\n\nMarkdown is widely used for formatting readme files, writing messages in online discussion forums, and creating rich text using a plain text editor. Its simplicity and readability make it a popular choice for developers, writers, and content creators.\n\n## Basic Markdown Formatting\n\n### Headings\n\nHeadings are created by adding one to six `#` symbols before your heading text. The number of `#` symbols corresponds to the level of the heading.\n\n```\n# Heading 1\n## Heading 2\n### Heading 3\n#### Heading 4\n##### Heading 5\n###### Heading 6\n```\n\n### Text\n\nYou can format text to be italic, bold, or bold-italic using asterisks (`*`) or underscores (`_`).\n\n```\n*italic* or _italic_\n**bold**\n***bold-italic***\n```\n\n**_To add a link: wrap the text which you want to be linked in square brackets, followed by the URL to be linked to in parenthesis._**\n\n```\n[text](URL)\n```\n\nExample: [Refresh](https://github.com/asmitranjansinha/theUltimateGuideToMarkdown)\n\n### Images\n\nMarkdown images have exactly the same formatting as a link, except they’re prefixed with a `!`. This time, the text in brackets is the alt text - or the descriptive text for the image.\n\n```\n![ImageTitle](ImageUrl)\n```\n\n![DisasterGirl](https://ichef.bbci.co.uk/news/976/cpsprodpb/F1F2/production/_118283916_b19c5a1f-162b-410b-8169-f58f0d153752.jpg.webp)\n\n### Lists\n\n#### Unordered Lists\n\nFor a bullet list, just prefix each line with a `*`, `-`, or `+`. You can also create nested lists; just indent a line with 4 spaces and it will be nested under the line above.\n\n```\n* Main\n* Main\n    * Sub\n* Main\n```\n\nExample:\n- Feature\n- Feature\n  - Components\n- Feature\n\n#### Ordered Lists\n\nOrdered lists are created by prefixing each line with a number followed by a period.\n\n```\n1. First item\n2. Second item\n3. Third item\n    1. Indented item\n    2. Indented item\n4. Fourth item\n```\n\nExample:\n1. Step 1\n2. Step 2\n3. Step 3\n    1. Sub-step 1\n    2. Sub-step 2\n4. Step 4\n\n### Quotes\n\nBlockquotes are created by prefixing the line with a `\u003e` symbol.\n\n```\n\u003e Your quotes go here.\n```\n\nExample:\n\u003e I drink and I know things!  \n\u003e -Tyrion\n\n### Code\n\nInline code can be created by wrapping text in backticks (`` ` ``).\n\n```\nThis is `inline code`.\n```\n\nFor code blocks, wrap the code in triple backticks (``` ``` ```) or indent each line with 4 spaces.\n\n    ```\n    function helloWorld() {\n        console.log(\"Hello, world!\");\n    }\n    ```\n\nExample:\n```javascript\nfunction helloWorld() {\n    console.log(\"Hello, world!\");\n}\n```\n\n### Horizontal Rules\n\nHorizontal rules can be created by using three or more hyphens (`-`), asterisks (`*`), or underscores (`_`).\n\n```\n---\n```\n\nExample:\n---\n\n### Tables\n\nTables can be created using pipes (`|`) and hyphens (`-`).\n\n```\n| Header 1 | Header 2 | Header 3 |\n|----------|----------|----------|\n| Row 1    | Data     | Data     |\n| Row 2    | Data     | Data     |\n```\n\nExample:\n| Syntax      | Description |\n|-------------|-------------|\n| Header      | Title       |\n| Paragraph   | Text        |\n\n### Task Lists\n\nTask lists can be created using `- [ ]` for unchecked items and `- [x]` for checked items.\n\n```\n- [x] Completed task\n- [ ] Incomplete task\n```\n\nExample:\n- [x] Write the press release\n- [ ] Update the website\n- [ ] Contact the media\n\n### Escaping Characters\n\nIf you need to display a character that is used for formatting in Markdown, you can escape it using a backslash (`\\`).\n\n```\n\\*This is not italic\\*\n```\n\nExample:\n\\*This is not italic\\*\n\n### Inline HTML\n\nIf you need more control over your content, you can use inline HTML within your Markdown.\n\n```\n\u003cp style=\"color:red;\"\u003eThis is a red paragraph.\u003c/p\u003e\n```\n\nExample:\n\u003cp style=\"color:red;\"\u003eThis is a red paragraph.\u003c/p\u003e\n\n### Footnotes\n\nFootnotes can be added using the following syntax:\n\n```\nHere is a footnote reference,[^1] and another.[^2]\n\n[^1]: This is the first footnote.\n[^2]: This is the second footnote.\n```\n\nExample:\nHere is a footnote reference,[^1] and another.[^2]\n\n[^1]: This is the first footnote.\n[^2]: This is the second footnote.\n\n### Strikethrough\n\nStrikethrough text can be created using two tildes (`~~`).\n\n```\n~~This text is strikethrough.~~\n```\n\nExample:\n~~This text is strikethrough.~~\n\n### Emojis\n\nYou can add emojis by using the appropriate shortcode.\n\n```\n:smile: :heart: :rocket:\n```\n\nExample:\n:smile: :heart: :rocket:\n\n### Advanced Formatting\n\n#### Definition Lists\n\nSome Markdown processors support definition lists.\n\n```\nTerm 1\n: Definition 1\n\nTerm 2\n: Definition 2\n```\n\nExample:\nTerm 1\n: Definition 1\n\nTerm 2\n: Definition 2\n\n#### Abbreviations\n\nSome Markdown processors support abbreviations.\n\n```\n*[HTML]: HyperText Markup Language\n*[CSS]: Cascading Style Sheets\n\nThe HTML specification is maintained by the W3C.\n```\n\nExample:\n*[HTML]: HyperText Markup Language\n*[CSS]: Cascading Style Sheets\n\nThe HTML specification is maintained by the W3C.\n\n#### Superscript and Subscript\n\nSome Markdown processors support superscript and subscript.\n\n```\nH~2~O and 2^10^\n```\n\nExample:\nH~2~O and 2^10^\n\n***May or may not get updated, Come back to check!***\n\nThis is my ultimate guide to Markdown readme. Feel free to contribute and add more content to this guide!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasmitranjansinha%2Fmarkdown-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fasmitranjansinha%2Fmarkdown-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fasmitranjansinha%2Fmarkdown-guide/lists"}