{"id":22940843,"url":"https://github.com/scottgriv/markdown-demo","last_synced_at":"2025-04-15T23:23:14.868Z","repository":{"id":192305957,"uuid":"686358725","full_name":"scottgriv/markdown-demo","owner":"scottgriv","description":"This repository serves as a comprehensive guide to Markdown syntax. Markdown is a lightweight markup language that you can use to add formatting elements to plaintext text documents.","archived":false,"fork":false,"pushed_at":"2025-01-09T04:14:57.000Z","size":543,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-02-06T07:41:20.941Z","etag":null,"topics":["documentation","markdown","markdown-demo"],"latest_commit_sha":null,"homepage":"","language":"Markdown","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/scottgriv.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null}},"created_at":"2023-09-02T14:22:57.000Z","updated_at":"2025-01-09T04:15:01.000Z","dependencies_parsed_at":"2023-09-04T04:08:16.857Z","dependency_job_id":null,"html_url":"https://github.com/scottgriv/markdown-demo","commit_stats":null,"previous_names":["night-owl-labs/markdown-demo","scottgriv/markdown-demo"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgriv%2Fmarkdown-demo","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgriv%2Fmarkdown-demo/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgriv%2Fmarkdown-demo/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/scottgriv%2Fmarkdown-demo/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/scottgriv","download_url":"https://codeload.github.com/scottgriv/markdown-demo/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":237652360,"owners_count":19344873,"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":["documentation","markdown","markdown-demo"],"created_at":"2024-12-14T13:32:39.856Z","updated_at":"2025-04-15T23:23:14.836Z","avatar_url":"https://github.com/scottgriv.png","language":"Markdown","funding_links":["https://www.buymeacoffee.com/scottgriv"],"categories":[],"sub_categories":[],"readme":"\u003c!-- Begin README --\u003e\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://github.com/scottgriv/markdown-demo\" target=\"_blank\"\u003e\n        \u003cimg src=\"./docs/images/icon.png\" width=\"200\" height=\"200\"/\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\u003cp align=\"center\"\u003e\n    \u003ca href=\"https://daringfireball.net/projects/markdown/\"\u003e\u003cimg src=\"https://img.shields.io/badge/Markdown-1.0.1-000000?style=for-the-badge\u0026logo=markdown\" alt=\"Markdown Badge\" /\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://github.com/scottgriv\"\u003e\u003cimg src=\"https://img.shields.io/badge/github-follow_me-181717?style=for-the-badge\u0026logo=github\u0026color=181717\" alt=\"GitHub Badge\" /\u003e\u003c/a\u003e\n    \u003ca href=\"mailto:scott.grivner@gmail.com\"\u003e\u003cimg src=\"https://img.shields.io/badge/gmail-contact_me-EA4335?style=for-the-badge\u0026logo=gmail\" alt=\"Email Badge\" /\u003e\u003c/a\u003e\n    \u003ca href=\"https://www.buymeacoffee.com/scottgriv\"\u003e\u003cimg src=\"https://img.shields.io/badge/buy_me_a_coffee-support_me-FFDD00?style=for-the-badge\u0026logo=buymeacoffee\u0026color=FFDD00\" alt=\"BuyMeACoffee Badge\" /\u003e\u003c/a\u003e\n    \u003cbr\u003e\n    \u003ca href=\"https://prgportfolio.com\" target=\"_blank\"\u003e\u003cimg src=\"https://img.shields.io/badge/PRG-Bronze Project-CD7F32?style=for-the-badge\u0026logo=data:image/svg%2bxml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBzdGFuZGFsb25lPSJubyI/Pgo8IURPQ1RZUEUgc3ZnIFBVQkxJQyAiLS8vVzNDLy9EVEQgU1ZHIDIwMDEwOTA0Ly9FTiIKICJodHRwOi8vd3d3LnczLm9yZy9UUi8yMDAxL1JFQy1TVkctMjAwMTA5MDQvRFREL3N2ZzEwLmR0ZCI+CjxzdmcgdmVyc2lvbj0iMS4wIiB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiB3aWR0aD0iMjYuMDAwMDAwcHQiIGhlaWdodD0iMzQuMDAwMDAwcHQiIHZpZXdCb3g9IjAgMCAyNi4wMDAwMDAgMzQuMDAwMDAwIgogcHJlc2VydmVBc3BlY3RSYXRpbz0ieE1pZFlNaWQgbWVldCI+Cgo8ZyB0cmFuc2Zvcm09InRyYW5zbGF0ZSgwLjAwMDAwMCwzNC4wMDAwMDApIHNjYWxlKDAuMTAwMDAwLC0wLjEwMDAwMCkiCmZpbGw9IiNDRDdGMzIiIHN0cm9rZT0ibm9uZSI+CjxwYXRoIGQ9Ik0xMiAzMjggYy04IC04IC0xMiAtNTEgLTEyIC0xMzUgMCAtMTA5IDIgLTEyNSAxOSAtMTQwIDQyIC0zOCA0OAotNDIgNTkgLTMxIDcgNyAxNyA2IDMxIC0xIDEzIC03IDIxIC04IDIxIC0yIDAgNiAyOCAxMSA2MyAxMyBsNjIgMyAwIDE1MCAwCjE1MCAtMTE1IDMgYy04MSAyIC0xMTkgLTEgLTEyOCAtMTB6IG0xMDIgLTc0IGMtNiAtMzMgLTUgLTM2IDE3IC0zMiAxOCAyIDIzCjggMjEgMjUgLTMgMjQgMTUgNDAgMzAgMjUgMTQgLTE0IC0xNyAtNTkgLTQ4IC02NiAtMjAgLTUgLTIzIC0xMSAtMTggLTMyIDYKLTIxIDMgLTI1IC0xMSAtMjIgLTE2IDIgLTE4IDEzIC0xOCA2NiAxIDc3IDAgNzIgMTggNzIgMTMgMCAxNSAtNyA5IC0zNnoKbTExNiAtMTY5IGMwIC0yMyAtMyAtMjUgLTQ5IC0yNSAtNDAgMCAtNTAgMyAtNTQgMjAgLTMgMTQgLTE0IDIwIC0zMiAyMCAtMTgKMCAtMjkgLTYgLTMyIC0yMCAtNyAtMjUgLTIzIC0yNiAtMjMgLTIgMCAyOSA4IDMyIDEwMiAzMiA4NyAwIDg4IDAgODggLTI1eiIvPgo8L2c+Cjwvc3ZnPgo=\" alt=\"Bronze\" /\u003e\u003c/a\u003e\n\u003c/p\u003e\n\n---------------\n\n\u003ch1 align=\"center\"\u003eComprehensive Markdown Guide\u003c/h1\u003e\n\nThis document provides a comprehensive guide to **Markdown syntax**—a lightweight markup language used to format plain text.\n\nUse this guide alongside a Markdown previewer or formatter to compare the rendered output with the original raw text for a better understanding of how Markdown works.\n\n---------------\n\n## Table of Contents\n\n- [Introduction](#introduction)\n  - [Why Use Markdown?](#why-use-markdown)\n- [Headers](#headers)\n- [Emphasis](#emphasis)\n- [Lists](#lists)\n  - [Unordered Lists](#unordered-lists)\n  - [Ordered Lists](#ordered-lists)\n- [Links](#links)\n- [Images](#images)\n- [Code](#code)\n  - [Inline code](#inline-code)\n  - [Block code without syntax highlighting](#block-code-without-syntax-highlighting)\n  - [Block code with syntax highlighting](#block-code-with-syntax-highlighting)\n- [Tables](#tables)\n- [Horizontal Rules](#horizontal-rules)\n- [Blockquotes](#blockquotes)\n- [Inline HTML](#inline-html)\n- [Escaping Characters](#escaping-characters)\n- [Task Lists](#task-lists)\n- [Footnotes](#footnotes)\n- [Definition Lists](#definition-lists)\n- [Automatic URL Linking](#automatic-url-linking)\n- [Emojis](#emojis)\n- [Math Equations](#math-equations)\n- [Abbreviations](#abbreviations)\n- [Citations](#citations)\n- [Alerts \u0026 Callouts](#alerts\u0026callouts)\n  - [Alerts](#alerts)\n  - [Callouts](#callouts)\n- [Tags](#tags)\n- [HTML Support](#html-support)\n- [Closing](#closing)\n- [Resources](#resources)\n- [License](#license)\n- [Credits](#credits)\n\n## Introduction\n\nMarkdown is a lightweight markup language that was created by John Gruber and Aaron Swartz in 2004. The primary goal of Markdown is readability—the idea is that a Markdown-formatted document should be publishable as-is, as plain text, without looking like it's been marked up with tags or formatting instructions.\n\nMarkdown has gained immense popularity over the years because of its simplicity and readability. It's widely used for writing README files, documentation, blog posts, forums, and even in chat applications.\n\n### Why Use Markdown?\n\n- **Readability**: Markdown's syntax is designed to be simple and intuitive.\n- **Platform Independent**: You can use Markdown in a text editor, in a web editor, or as the formatting syntax for entire platforms.\n- **Rich Output**: With simple syntax, you can produce rich text formatting.\n- **Compatibility**: Many platforms automatically convert Markdown to HTML, making it easy to display rich text in a web browser.\n- **Extensible**: While standard Markdown handles most common use cases, many platforms introduce their own extensions (called 'flavors') to add additional functionality like tables, code blocks, and more.\n\n## Headers\n\n```markdown\n# H1\n## H2\n### H3\n#### H4\n##### H5\n###### H6\n```\n# H1\n## H2\n### H3\n#### H4\n##### H5\n###### H6\n\n## Emphasis\n\n```markdown\n*italic* or _italic_\n**bold** or __bold__\n**_bold and italic_**\n~~strikethrough~~\n```\n*italic* or _italic_ \u003cbr\u003e\n**bold** or __bold__ \u003cbr\u003e\n**_bold and italic_** \u003cbr\u003e\n~~strikethrough~~ \u003cbr\u003e\n\n## Lists\n\n### Unordered Lists\n\n```markdown\n* Item 1\n* Item 2\n  * Item 2a\n  * Item 2b\n```\n* Item 1\n* Item 2\n  * Item 2a\n  * Item 2b\n\n*Or using dashes:*\n\n```markdown\n- Item 1\n- Item 2\n  - Item 2a\n  - Item 2b\n```\n- Item 1\n- Item 2\n  - Item 2a\n  - Item 2b\n\n### Ordered Lists\n\n```markdown\n1. Item 1\n2. Item 2\n3. Item 3\n   1. Item 3a\n   2. Item 3b\n```\n1. Item 1\n2. Item 2\n3. Item 3\n   1. Item 3a\n   2. Item 3b\n\n## Links\n\n```markdown\nhttp://github.com\n[GitHub with Title](http://github.com)\n```\nhttp://github.com \u003cbr\u003e\n[GitHub with Title](http://github.com)\n\n## Images\n\n```markdown\n![GitHub-Mark-Light](/docs/images/github-mark-white.png#gh-dark-mode-only)\n![GitHub-Mark-Dark](/docs/images/github-mark.png#gh-light-mode-only)\n```\n![GitHub-Mark-Light](/docs/images/github-mark-white.png#gh-dark-mode-only) \u003cbr\u003e\n![GitHub-Mark-Dark](/docs/images/github-mark.png#gh-light-mode-only)\n\n*Add #gh-light-mode-only or #gh-dark-mode-only to the end of the image link to make it only visible in light or dark mode, respectively.*\n\n## Code: \n\n### Inline code:\n\n```markdown\nHere is `inline code`.\n```\nHere is `inline code`.\n\n### Block code without syntax highlighting:\n\n```markdown\n```This is a block of code.```\n```\n```\nThis is a block of code.\n```\n\n### Block code with syntax highlighting:\n\n```markdown\n```python \nprint(\"Hello, world!\")\n```\n\n```python\nprint(\"Hello, world!\")\n```\n\n## Tables\n\n```markdown\n| Header One     | Header Two     |\n| -------------- | -------------- |\n| Content Cell 1 | Content Cell 2 |\n| Content Cell 3 | Content Cell 4 |\n```\n| Header One     | Header Two     |\n| -------------- | -------------- |\n| Content Cell 1 | Content Cell 2 |\n| Content Cell 3 | Content Cell 4 |\n\n## Horizontal Rules\n\nUse three or more dashes, asterisks, or underscores:\n\n```markdown\n---\n***\n___\n```\n---\n***\n___\n\n## Blockquotes\n\n``` markdown\n\u003e This is a blockquote.\n\u003e\n\u003e \u003e This is a nested blockquote.\n```\n\u003e This is a blockquote.\n\u003e\n\u003e \u003e This is a nested blockquote.\n\n## Inline HTML\n\n```html\n\u003cspan style=\"color:red\"\u003eThis is red text.\u003c/span\u003e\n\u003cdiv align=\"center\"\u003eCentered Text\u003c/div\u003e\n```\n\u003cspan style=\"color:red\"\u003eThis is red text.\u003c/span\u003e\n\u003cdiv align=\"center\"\u003eCentered Text\u003c/div\u003e\n\n## Escaping Characters\n\nBackslash escapes Markdown characters:\n\n```markdown\n\\*Not italic\\*\n\\# Not a header\n```\n\\*Not italic\\* \u003cbr\u003e\n\\# Not a header\n\n## Task Lists\n\nIn GitHub Flavored Markdown, you can create task lists:\n\n```markdown\n- [x] Completed task\n- [ ] Incomplete task\n```\n- [x] Completed task\n- [ ] Incomplete task\n\n## Footnotes\n\nSome Markdown processors allow you to use footnotes, like so:\n\n```markdown\nHere's a sentence with a footnote. [^1]\n[^1]: This is the footnote.\n```\nHere's a sentence with a footnote. [^1] \u003cbr\u003e\n[^1]: This is the footnote.\n\n## Definition Lists\n\nNot universally supported, but useful where available:\n\n```markdown\nApple\n:   Pomaceous fruit of plants of the genus Malus in the family Rosaceae.\nOrange\n:   The fruit of an evergreen tree of the genus Citrus.\n```\nApple \u003cbr\u003e\n:   Pomaceous fruit of plants of the genus Malus in the family Rosaceae. \u003cbr\u003e\nOrange \u003cbr\u003e\n:   The fruit of an evergreen tree of the genus Citrus.\n\n## Automatic URL Linking\n\nMost Markdown processors will automatically turn URLs into links:\n\n```markdown\nhttp://www.example.com\n```\nhttp://www.example.com\n\n## Emojis\n\nOn platforms that support it (like GitHub), you can use shorthand for emojis:\n\n```markdown\n:smile: :+1:\n```\n:smile: :+1:\n\n## Math Equations\n\nSome Markdown renderers like the one used by Jupyter Notebook support `LaTeX` for rendering math equations:\n\n```markdown\n```math\nE = mc^2\n```\n\n```math\nE = mc^2\n```\n\n## Abbreviations\n\nSome extended Markdown processors allow abbreviations:\n\n```markdown\n*[HTML]: Hyper Text Markup Language\n*[W3C]:  World Wide Web Consortium\n```\n*[HTML]: Hyper Text Markup Language \u003cbr\u003e\n*[W3C]:  World Wide Web Consortium\n\n## Citations\n\nCertain academic Markdown variants allow citations in `BibTeX` format:\n\n```markdown\nAccording to Smith [@smith04], blah blah...\n[@smith04]: John Smith. 2004. The Book Title. Publisher Name.\n```\nAccording to Smith [@smith04], blah blah... \u003cbr\u003e\n[@smith04]: John Smith. 2004. The Book Title. Publisher Name.\n\n## Alerts \u0026 Callouts\n\nUse alerts/callouts to include additional content without breaking the flow of your notes.\n\n### Alerts\n\nGitHub Flavored Markdown supports alerts that can be used to highlight important information:\n\n```markdown\n  \u003e [!NOTE]  \n  \u003e Highlights information that users should take into account, even when skimming.\n\n  \u003e [!TIP]\n  \u003e Optional information to help a user be more successful.\n\n  \u003e [!IMPORTANT]  \n  \u003e Crucial information necessary for users to succeed.\n\n  \u003e [!WARNING]  \n  \u003e Critical content demanding immediate user attention due to potential risks.\n\n  \u003e [!CAUTION]\n  \u003e Negative potential consequences of an action.\n```\n\n\u003e [!NOTE]  \n\u003e Highlights information that users should take into account, even when skimming.\n\n\u003e [!TIP]\n\u003e Optional information to help a user be more successful.\n\n\u003e [!IMPORTANT]  \n\u003e Crucial information necessary for users to succeed.\n\n\u003e [!WARNING]  \n\u003e Critical content demanding immediate user attention due to potential risks.\n\n\u003e [!CAUTION]\n\u003e Negative potential consequences of an action.\n\n### Callouts \n\nOther markdown editors have their own methods and features for Alerts/Callouts.\nFor Obsidian, for example, check out their document [here](https://help.obsidian.md/callouts) for more information.\n\n## Tags\n\nMarkdown editiors like Obsidian may support tags to organize your topics across multiple markdown documents:\n\n```markdown\n#TestTag1 #TestTag2\n```\n\n#TestTag1 #TestTag2\n\n## HTML Support\n\nMost Markdown editors also support inline `HTML`, allowing you to incorporate elements that Markdown doesn't natively support—such as tables with advanced formatting, custom divs, or embedded media.\n\n## Closing\n\nRemember, not all of these features are supported in every Markdown processor. Always check your specific processor's documentation for supported features.\n\nYou can use this as a README for your repository. Feel free to expand and improve the guide to better fit your requirements or to add more advanced features. Also, feel free to contribute and expand this guide for better community knowledge.\n\n## Resources\n\n- [Markdown Guide](https://www.markdownguide.org/) - A free and open-source reference guide that explains how to use Markdown.\n- [Daring Fireball](https://daringfireball.net/projects/markdown/) - The original Markdown project by John Gruber.\n- [GitHub Flavored Markdown](https://github.github.com/gfm/) - GitHub's variant of Markdown, which includes features like task lists and tables.\n- [CommonMark](https://commonmark.org/) - A strong specification of Markdown, designed to clarify many edge cases and inconsistencies in the original Markdown specification.\n- [Markdown Cheatsheet](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) - A quick reference to Markdown syntax.\n- [Pandoc](https://pandoc.org/) - A universal document converter that supports Markdown and many other markup languages.\n- [StackEdit](https://stackedit.io/) - An in-browser Markdown editor.\n- [Markdown Tutorial](https://chat.openai.com/?model=gpt-4#:~:text=browser%20Markdown%20editor.-,Markdown%20Tutorial,-%3A%20An%20interactive%20tutorial) - An interactive tutorial to learn Markdown.\n- [Jupyter Notebook](https://jupyter.org/) - Although not strictly a Markdown resource, Jupyter Notebooks use Markdown for all non-code cells, making it a useful tool for scientific documentation where code and commentary are intermixed.\n- [GitHub Markdown Alerts](https://blog.jakelee.co.uk/github-alert-experiments/) - A blog post that discusses the use of GitHub Markdown Alerts\n- [GitHub Markdown Alerts Discussion](https://github.com/orgs/community/discussions/16925) - A GitHub discussion that discusses the use of GitHub Markdown Alerts\n- [Obsidian Callouts](https://help.obsidian.md/callouts) - Use callouts to include additional content without breaking the flow of your notes.\n\n## License\n\nThis project is released under the terms of the **MIT License**, which permits use, modification, and distribution of the code, subject to the conditions outlined in the license.\n- The [MIT License](https://choosealicense.com/licenses/mit/) provides certain freedoms while preserving rights of attribution to the original creators.\n- For more details, see the [LICENSE](LICENSE) file in this repository. in this repository.\n\n## Credits\n\n**Author:** [Scott Grivner](https://github.com/scottgriv) \u003cbr\u003e\n**Email:** [scott.grivner@gmail.com](mailto:scott.grivner@gmail.com) \u003cbr\u003e\n**Website:** [scottgrivner.dev](https://www.scottgrivner.dev) \u003cbr\u003e\n**Reference:** [Main Branch](https://github.com/scottgriv/markdown-demo) \u003cbr\u003e\n\n---------------\n\n\u003cdiv align=\"center\"\u003e\n    \u003ca href=\"https://scottgrivner.dev\" target=\"_blank\"\u003e\n        \u003cimg src=\"./docs/images/footer.png\" width=\"100\" height=\"100\"/\u003e\n    \u003c/a\u003e\n\u003c/div\u003e\n\n\u003c!-- End README --\u003e","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscottgriv%2Fmarkdown-demo","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fscottgriv%2Fmarkdown-demo","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fscottgriv%2Fmarkdown-demo/lists"}