{"id":19110691,"url":"https://github.com/dipree/github-markdown","last_synced_at":"2025-02-22T11:20:32.346Z","repository":{"id":44576010,"uuid":"435475940","full_name":"dipree/github-markdown","owner":"dipree","description":null,"archived":false,"fork":false,"pushed_at":"2023-11-18T19:44:51.000Z","size":50,"stargazers_count":30,"open_issues_count":6,"forks_count":7,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-02-17T21:13:29.823Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"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/dipree.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":"2021-12-06T11:47:31.000Z","updated_at":"2025-02-17T05:55:03.000Z","dependencies_parsed_at":"2023-11-18T20:30:37.940Z","dependency_job_id":"a8bdfe9d-f5cf-465c-9059-e9b7892abb67","html_url":"https://github.com/dipree/github-markdown","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/dipree%2Fgithub-markdown","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipree%2Fgithub-markdown/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipree%2Fgithub-markdown/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dipree%2Fgithub-markdown/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dipree","download_url":"https://codeload.github.com/dipree/github-markdown/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240164843,"owners_count":19758261,"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":[],"created_at":"2024-11-09T04:25:45.915Z","updated_at":"2025-02-22T11:20:32.095Z","avatar_url":"https://github.com/dipree.png","language":null,"readme":"# GitHub Markdown\nOverview of the Markdown rendering in GitHub. This document does not cover HTML tags on the allowlist.\n\n## Headings\n\nYou can use up to up to six levels by writing `#` at the start of a line. The number of hashtags defines the hierarchy of the heading. The first two headings render with a horizontal separator.\n\n```Markdown\n# First level\n## Second level\n### Third level\n#### Fourth level\n##### Fifth level\n###### Sixth level\n```\n\n### Linking to Headings\nIn Markdown documents, each heading has its name as the identifier which you can [link to](#linking-to-headings) via a fragment.\n\n```Markdown\n[link to](#linking-to-headings)\n```\n\n## Emphasize\nEmphasize text with different meanings.\n\n### Bold\nUse double astersik or double underscore before and after text to denote **bold**.\n\n```Markdown\n**bold**\n__bold__\n```\n\n### Italic\nUse single asterisk or underscore before and after text to denote *italic*.\n\n```Markdown\n*italic*\n_italic_\n```\n\n### Strikethrough\nUse double tildes before and after text to ~~strikethrough~~.\n\n```Markdown\n~~strikethrough~~\n```\n\n## Paragraphs\nUse a blank line to separate one or more lines of text.\n\n```Markdown\na paragraph\n\nanoter paragraph\n```\n\n## Line Breaks\nUse a backslash or two or more spaces at the end of a line, then type return to define a line break.\n\n\u003e [!NOTE]  \n\u003e This works inconsistently in Markdown documents versus comments. In a comment, a soft line break (return) does render a line break.\n\nfirst line\\\nsecond line\n\n```Markdown\nfirst line\\\nsecond line\n```\n\n## Code\n\n### Inline Code Block\nUse a backtick before and after text to denote as `inline code`.\n\n```Markdown\n`code`\n```\n\n### Fenced Code Block\nUse three backticks in a separate line before and after `code` or add at least four spaces to the start of a line.\n\n````Markdown\n```\ncode\n```\n````\n\n```Markdown\ncode\n```\n\n### Syntax Highlighting\nAdd syntax highlighting by specifying a language next to the backticks before a fenced code block.\n\n````Markdown\n```javascript\nfunction markdownRocks() {\n  return true\n}\n```\n````\n\n### Escaping Backticks\n\nInline code blocks can be escaped using double backticks. Fenced code blocks using backticks can be escaped using three tildes `~~~` or four backticks `` ```` ``.\n\n## Blockquotes\nAdd a greater-than sign in front of a paragraph.\n\n\u003e To create a blockquote.\n\n```Markdown\n\u003e a quoted pragraph\n\u003e \n\u003e another quoted paragraph\n```\n\n### Nested Blockquotes\nAdd two greater-than signs in front of the paragraph you want to nest.\n\n\u003e a quoted paragraph\n\u003e\u003e a quoted paragraph inside a quotation\n\n```Markdown\n\u003e a quoted paragraph\n\u003e\u003e a quoted paragraph inside a quotation\n```\n\n## Lists\n\n### Numbered List\nAdd a figure followed by period, then a space and your content for each line item. The figure of the first item defines the sequence, figures of the following lines won't be considered.\n\n1. numbered list item\n2. numbered list item\n3. numbered list item\n\n```Markdown\n1. numbered list item\n2. numbered list item\n3. numbered list item\n```\n\n### Bulleted Lists\nAdd an asterisk, dash or plus sign followed by period, then a space and your content for each line item.\n\n* bulleted list item\n* bulleted list item\n* bulleted list item\n\n```Markdown\n* bulleted list item\n* bulleted list item\n* bulleted list item\n```\n\n### Task Lists\nAdd a dash followed by a space, then brackets **with a space in between**, then another space and your content for each task.\n\n- [ ] Unfinished task list item\n- [x] Finished task list item\n\n```Markdown\n- [ ] Unfinished task list item\n- [x] Finished task list item\n```\n\n### Nesting Lists\nAdd two spaces to indent a list item and another two spaces for every next level. You can use up to ten levels. Mixing numbered and bulleted lists is possible.\n\n* first level\n  * second level\n\n```Markdown\n* first level\n  * second level\n\n1. first level\n  1. second level\n\n* first level unordered list item\n  1. second level ordered list item\n```\n\n## Links\nAdd the text in brackets, then add the path or URL in parentheses.\n\n```Markdown\n[this is a link](http://github.com/)\n```\n\n## Images\nAdd an exclamation mark, followed by alt text in brackets, and the path or URL to the image asset in parentheses.\n\n\u003e [!NOTE]  \n\u003e The output automatically wraps the image in a link leading to the image url if no link is specified.\n\n```Markdown\n![alt text](http://github.com/image.jpg)\n```\n\n_For accessibility reasons, make sure the alt text describes the image content precisely!_\n\n### Linking images\nAdd a link to an image by enclosing the Markdown for the image in brackets, and then add the link in parentheses.\n\n```Markdown\n[![alt text](http://github.com/image.jpg)](http://github.com/image.jpg)\n```\n\n## Footnotes\n\nAdd a footnote in square brackets preceded by a caret and an identifier[^1]. The footnote content can be added by using the before mentioned construct followed by colon and then the content.\n\n[^1]: Identifiers can be numbers or words without spaces or tabs.\n\n```Markdown\nText with a footnote[^1].\n\n[^1]: The footnote can be defined anywhere in the document but will be rendered at the end.\n```\n\n## Tables\nCreate a table by denoting each cell with pipe characters. Use three or more hyphens in the second row to create each column, this is mandatory. \n\n| column 1 | column 2 |\n|---|---|\n| cell | cell | \n| cell | cell | \n\n```Markdown\n| column 1 | column 2 |\n|---|---|\n| cell | cell | \n| cell | cell | \n```\n\n### Alignment\nAdd a colon to the left, right, or on both side of the hyphens in the second row to align text of the columns accordingly.\n\n| column 1 | column 2 | column 3 |\n|:--- | :---:| ---:|\n| left | center | right |\n| left | center | right |\n\n```Markdown\n| column 1 | column 2 | column 3 |\n|:--- | :---:| ---:|\n| left | center | right |\n| left | center | right |\n```\n\n### Formatting Text\nYou can [emphasize](#Emphasize) text, add [links](#Links), [images](#Images) and [inline code blocks](#Inline-Code-Blocks) in tables.\n\n## Horizontal Rules\nUse three or more asterisks, dashes, or underscores alone on a line.\n\n---\n\n```Markdown\n---\n***\n___\n```\n\n## Special Rendering\nGitHub Markdown has special rendering for certain things.\n\n### URLs\nReferencing specific url formats renders special.\n\n#### Issues \u0026 Pull Requests\nFrom the same or a different repository.\n\n\u003e [!NOTE]  \n\u003e Issues and PRs referenced in lists render with the format `icon title id` in [comments](https://github.com/dipree/github-markdown/issues/13)\n\nhttps://github.com/dipree/github-markdown/issues/1  \nhttps://github.com/dipree/dipree/issues/1\n\n```Markdown\nhttps://github.com/dipree/github-markdown/issues/1  \nhttps://github.com/dipree/dipree/issues/1\n```\n\n#### Labels\nFrom the same repository.\n\nhttps://github.com/dipree/github-markdown/labels/demo\n\n```Markdown\nhttps://github.com/dipree/github-markdown/labels/demo\n```\n\n### Alerts\n\nAlerts emphasize critical information. They are displayed with distinctive colors and icons to indicate the importance of the content.\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```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### Colors\nSpecifying colors as HEX, RGBA or HSL in inline code blocks renders a little dot of the given color within the code block.\n\n\u003e [!NOTE]  \n\u003e Only works in Markdown [comments](https://github.com/dipree/github-markdown/issues/12), not in files.\n\n```\n`#00ff00`, `rgba(0, 255, 0, 1)`, `hsl(120, 100%, 50%)`\n```\n\n### Mermaid Diagrams\nCode blocks with the syntax highlighting set to `mermaid` renders dynamical diagrams using the [Mermaid syntax](https://mermaid.js.org/syntax/classDiagram.html).\n\n```mermaid\nstateDiagram\n    direction LR\n    Input --\u003e Blackbox\n    Blackbox --\u003e Output\n    state Blackbox {\n      direction LR\n      🪄 \n    }\n```\n\n````\n```mermaid\nstateDiagram\n    direction LR\n    Input --\u003e Blackbox\n    Blackbox --\u003e Output\n    state Blackbox {\n      direction LR\n      🪄 \n    }\n```\n````\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdipree%2Fgithub-markdown","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdipree%2Fgithub-markdown","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdipree%2Fgithub-markdown/lists"}