{"id":35881657,"url":"https://github.com/jonahbenedicto/github-markdown-guide","last_synced_at":"2026-01-08T18:03:41.928Z","repository":{"id":331324612,"uuid":"1126222594","full_name":"jonahbenedicto/github-markdown-guide","owner":"jonahbenedicto","description":"A comprehensive minimal guide for markdown on GitHub.","archived":false,"fork":false,"pushed_at":"2026-01-06T01:46:04.000Z","size":58,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2026-01-06T07:39:46.846Z","etag":null,"topics":["github","guide","markdown"],"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/jonahbenedicto.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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2026-01-01T12:27:47.000Z","updated_at":"2026-01-06T01:46:08.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jonahbenedicto/github-markdown-guide","commit_stats":null,"previous_names":["jonahbenedicto/github-markdown"],"tags_count":null,"template":false,"template_full_name":null,"purl":"pkg:github/jonahbenedicto/github-markdown-guide","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonahbenedicto%2Fgithub-markdown-guide","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonahbenedicto%2Fgithub-markdown-guide/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonahbenedicto%2Fgithub-markdown-guide/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonahbenedicto%2Fgithub-markdown-guide/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jonahbenedicto","download_url":"https://codeload.github.com/jonahbenedicto/github-markdown-guide/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jonahbenedicto%2Fgithub-markdown-guide/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28247283,"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","status":"online","status_checked_at":"2026-01-08T02:00:06.591Z","response_time":241,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["github","guide","markdown"],"created_at":"2026-01-08T18:01:10.221Z","updated_at":"2026-01-08T18:03:41.918Z","avatar_url":"https://github.com/jonahbenedicto.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# GitHub Markdown Guide\n\nA comprehensive minimal guide for markdown on GitHub. Keep this handy for quick reference.\n\n# Table of Contents\n\n- [Paragraph Text](#paragraph-text)\n- [Heading Text](#heading-text)\n- [Text Style](#text-style)\n- [Quote](#quote)\n- [Code](#code)\n- [Link](#link)\n- [Line Break](#line-break)\n- [Image](#image)\n- [List](#list)\n- [Emoji](#emoji)\n- [Footnote](#footnote)\n- [Alert](#alert)\n- [Comment](#comment)\n- [Ignore Markdown](#ignore-markdown)\n- [Table](#table)\n- [Collapsed Section](#collapsed-section)\n- [Diagrams](#diagrams)\n- [Math](#math)\n- [Quick Tips](#quick-tips)\n\n# Paragraph Text\n\nUse default text.\n\n# Heading Text\n\nUse `#` symbol.\n\n**Code:**\n\n```\n# Heading 1\n\n## Heading 2\n\n### Heading 3\n\n#### Heading 4\n\n##### Heading 5\n\n###### Heading 6\n```\n\n**Preview:**\n\n# Heading 1\n\n## Heading 2\n\n### Heading 3\n\n#### Heading 4\n\n##### Heading 5\n\n###### Heading 6\n\n# Text Style\n\n| Style | Code | Preview |\n|---|---|---|\n| Bold | `**bold**` | **bold** |\n| Italic | `*italic*` | *italic* |\n| Strikethrough | `~~strikethrough~~` | ~strikethrough~ |\n| Bold and italic | `***bold and italic***` | ***bold and italic*** |\n| Subscript | `\u003csub\\\u003esubscript\u003c/sub\u003e` | \u003csub\u003esubscript\u003c/sub\u003e |\n| Superscript | `\u003csup\\\u003esuperscript\u003c/sup\u003e` | \u003csup\u003esuperscript\u003c/sup\u003e |\n| Underline | `\u003cins\u003eunderline\u003c/ins\u003e` | \u003cins\u003eunderline\u003c/ins\u003e |\n\n# Quote\n\nUse `\u003e` symbol.\n\n**Code:**\n\n```\n\u003e Quote\n```\n\n**Preview:**\n\n\u003e Quote\n\n# Code\n\nUse `` ` `` symbol.\n\n## Inline Code\n\n**Code:**\n\n````\n`Inline code`\n````\n\n**Preview:**\n\n\n`Inline code`\n\nTo use `` ` `` symbol in inline code.\nUse multiple ``` `` ``` symbols  in the start and end of the inline code and block code.\n\n**Code:**\n```\n``Inline code with a backtick ` ``\n```\n\n**Preview:**\n\n``Inline code with a backtick ` ``\n\n## Block code\n\n**Code:**\n\n````\n```python\nprint(\"Hello, World!\")\n```\n````\n\n**Preview:**\n\n```python\nprint(\"Hello, World!\")\n```\n\nYou can specify the programming language (Optional).\n\n# Link\n\nUse `[ ]( )` symbols.\n\n## Normal Link\n\n**Code:**\n```\n[Google](https://www.google.com)\n```\n\n**Preview:**\n\n[Google](https://www.google.com)\n\n## Anchor Link\n\n**Code:**\n\n```\n[Table of Contents](#table-of-contents)\n```\n\n**Preview:** \n\n[Table of Contents](#table-of-contents)\n\n## Relative Link\n\n**Code:**\n```\n[image.png](./image.png)\n```\n\n**Preview:**\n\n[image.png](./image.png)\n\n## Custom Anchor Link\n\n**Code:**\n\n```\n[Custom Anchor Link](#custom-anchor-point)\n```\n\n**Preview:**\n\n[Custom Anchor Link](#custom-anchor-point)\n\n\u003e [!NOTE]\n\u003e A custom anchor link must have a corresponding custom anchor point.\n\n**Code:**\n```\n\u003ca name=\"custom-anchor-point\"\u003eCustom Anchor Point\u003c/a\u003e\n```\n\n**Preview:**\n\n\u003ca name=\"custom-anchor-point\"\u003eCustom Anchor Point\u003c/a\u003e\n\n\n# Line Break\n\nUse `\\` or `\u003cbr/\u003e`\n\n**Code:**\n\n```\nHello,\\\nWorld!\n\nor\n\nBye, \u003cbr/\u003e World!\n```\n\n**Preview:**\n\nHello,\\\nWorld!\n\nor\n\nBye, \u003cbr/\u003e World!\n\n# Image\n\nUse `![ ]( )` symbols.\n\n**Code:**\n\n```\n![Image](./image.png)\n```\n\n**Preview:**\n![Image](./image.png)\n\n# List\n\n## Unordered List\n\n**Code:**\n\n```\n- Item\n* Item\n+ Item\n```\n\n**Preview:**\n\n- Item\n* Item\n+ Item\n\n## Sorted List\n\n**Code:**\n\n```\n1. Item\n2. Item\n3. Item\n```\n\n**Preview:**\n\n1. Item\n2. Item\n3. Item\n\n## Nested List\n\n**Code:**\n```\n- Item\n    - Item\n        - Item\n```\n\n**Preview:**\n- Item\n    - Item\n        - Item\n\n## Task List\n\n**Code:**\n\n```\n- [x] Task\n- [ ] Task\n```\n\n**Preview:**\n\n- [x] Task\n- [ ] Task\n\n# Emoji\n\n**Use :emojicode:**\n\n**Code:** `:smile:`\n\n**Preview:** :smile:\n\n\u003e [!NOTE]\n\u003e For more information check out: [Emoji List Unicode](https://github.com/Fantantonio/Emoji-List-Unicode)\n\n# Footnote\n\n**Code:** \n\n```\nReference [^1]\n```\n\n**Preview:**\n\nReference [^1]\n\n\u003e [!NOTE]\n\u003e A Reference must have a corresponding Footnote\n\n**Code:**\n```\n[^1]: Footnote\n```\n\n**Preview:**\n\n[Jump to footnote](#real-footnote)\n\n[^1]: Footnote \u003ca name=\"real-footnote\"\u003e\u003c/a\u003e\n\n# Alert\n\n**Code:**\n\n```\n\u003e [!NOTE]\n\u003e Description\n```\n\n```\n\u003e [!TIP]\n\u003e Description\n```\n\n```\n\u003e [!IMPORTANT]\n\u003e Description\n```\n\n```\n\u003e [!WARNING]\n\u003e Description\n```\n\n```\n\u003e [!CAUTION]\n\u003e Description\n```\n\n**Preview:**\n\n\u003e [!NOTE]\n\u003e Description\n\n\u003e [!TIP]\n\u003e Description\n\n\u003e [!IMPORTANT]\n\u003e Description\n\n\u003e [!WARNING]\n\u003e Description\n\n\u003e [!CAUTION]\n\u003e Description\n\n# Comment\n\n**Use `\u003c!-- Comment --\u003e`**\n\n**Code:**\n\n```\nVisible text \u003c!-- hidden comment --\u003e\n```\n\n**Preview:**\n\nVisible text \u003c!-- hidden comment --\u003e\n\n\n# Ignore Markdown\n\nTo stop automatically formatting your text as markdown: \n**use `/` symbol**:\n\n**Code:**\n\n```\n\\*Not italic\\*\n\\# Not a heading\n\\\u003e Not a quote\n```\n\n**Preview:**\n\n\\*Not italic\\*\n\\# Not a heading\n\\\u003e Not a quote\n\n# Table\n\n## Basic Table\n\n**Code:**\n\n```\n| Header | Header |\n| --- | --- |\n| Cell | Cell |\n```\n\n**Preview:**\n\n| Header | Header |\n|---|---|\n| Cell | Cell |\n\n## Table Alignment\n\n**Code:**\n```\n| Left Alignment | Center Alignment | Right Alignment |\n| :--- | :---: | ---: |\n| Left | Center | Right |\n```\n\n**Preview:**\n\n| Left Alignment | Center Alignment | Right Alignment |\n| :--- | :---: | ---: |\n| Left | Center | Right |\n\n# Collapsed Section\n\n**Code:**\n\n```\n\u003cdetails\u003e\n\u003csummary\u003eClick to expand\u003c/summary\u003e\nHidden content here \n\u003c/details\u003e\n```\n\n**Preview:**\n\n\u003cdetails\u003e\n\u003csummary\u003eClick to expand\u003c/summary\u003e\nHidden content here \n\u003c/details\u003e\n\n# Diagrams\n\n## Mermaid Diagram\n\n**Code:**\n\n````\n```mermaid\ngraph TD;\n    A[Start] --\u003e B{Decision};\n    B --\u003e C[Yes];\n    B --\u003e D[No];\n```\n````\n\n**Preview:**\n\n```mermaid\ngraph TD;\n    A[Start] --\u003e B{Decision};\n    B --\u003e C[Yes];\n    B --\u003e D[No];\n```\n\n## GeoJSON Diagram\n\n**Code:**\n\n````\n```geojson\n{\n  \"type\": \"FeatureCollection\",\n  \"features\": [\n    {\n      \"type\": \"Feature\",\n      \"geometry\": {\n        \"type\": \"Point\",\n        \"coordinates\": [0, 0]\n      }\n    },\n    {\n      \"type\": \"Feature\",\n      \"geometry\": {\n        \"type\": \"LineString\",\n        \"coordinates\": [\n          [0, 0],\n          [5, 5],\n          [10, 0]\n        ]\n      }\n    }\n  ]\n}\n```\n````\n\n**Preview:**\n\n```geojson\n{\n  \"type\": \"FeatureCollection\",\n  \"features\": [\n    {\n      \"type\": \"Feature\",\n      \"geometry\": {\n        \"type\": \"Point\",\n        \"coordinates\": [0, 0]\n      }\n    },\n    {\n      \"type\": \"Feature\",\n      \"geometry\": {\n        \"type\": \"LineString\",\n        \"coordinates\": [\n          [0, 0],\n          [5, 5],\n          [10, 0]\n        ]\n      }\n    }\n  ]\n}\n```\n\n# Math\n\nUse `$` symbol.\n\n## Inline Math\n\n**Code:**\n\n```\nE = mc^2 and $\\sqrt{3x-1}+(1+x)^2$\n```\n\n**Preview:**\n\nE = mc^2 and $\\sqrt{3x-1}+(1+x)^2$\n\n## Math Block\n\n**Code:**\n\n```\n$$\n\\int_{a}^{b} f(x) dx = F(b) - F(a)\n$$\n```\n\n**Preview:**\n\n$$\n\\int_{a}^{b} f(x) dx = F(b) - F(a)\n$$\n\n\u003e [!NOTE]\n\u003e For more information visit: [Katex Docs](https://katex.org/docs/supported.html)\n\n# Quick Tips\n\n- Keep it simple and readable\n- Preview often (`Ctrl+Shift+V` in VS Code)\n- Use relative links for repo files\n- Escape special chars with `\\`\n- Add alt text to images\n- Keep tables narrow (\u003c5 columns)\n\n---\n\nKeep this guide handy for quick reference. Contribute via PR.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonahbenedicto%2Fgithub-markdown-guide","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjonahbenedicto%2Fgithub-markdown-guide","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjonahbenedicto%2Fgithub-markdown-guide/lists"}