{"id":13578604,"url":"https://github.com/darsaveli/Readme-Markdown-Syntax","last_synced_at":"2025-04-05T19:33:18.505Z","repository":{"id":39643402,"uuid":"381781751","full_name":"darsaveli/Readme-Markdown-Syntax","owner":"darsaveli","description":"🔥 The Best, Complete Guide to Master Markdown Syntax \u0026 Create Awesome READMEs😈  ","archived":false,"fork":false,"pushed_at":"2023-08-15T09:16:47.000Z","size":51,"stargazers_count":152,"open_issues_count":0,"forks_count":71,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-11-05T16:46:51.510Z","etag":null,"topics":["awesome-readme","markdown","markdown-syntax","readme","readme-mastertemplates","readme-md","readme-template","syntax","write-readmes"],"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/darsaveli.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}},"created_at":"2021-06-30T17:24:13.000Z","updated_at":"2024-11-02T11:23:12.000Z","dependencies_parsed_at":"2024-01-14T20:49:15.139Z","dependency_job_id":"a048cf6a-5576-48fd-bdb2-94931e641837","html_url":"https://github.com/darsaveli/Readme-Markdown-Syntax","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/darsaveli%2FReadme-Markdown-Syntax","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darsaveli%2FReadme-Markdown-Syntax/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darsaveli%2FReadme-Markdown-Syntax/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/darsaveli%2FReadme-Markdown-Syntax/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/darsaveli","download_url":"https://codeload.github.com/darsaveli/Readme-Markdown-Syntax/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247393094,"owners_count":20931804,"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":["awesome-readme","markdown","markdown-syntax","readme","readme-mastertemplates","readme-md","readme-template","syntax","write-readmes"],"created_at":"2024-08-01T15:01:32.153Z","updated_at":"2025-04-05T19:33:18.251Z","avatar_url":"https://github.com/darsaveli.png","language":null,"readme":"\u003ch1 align=\"center\"\u003eThe Complete Guide of \u003cbr\u003e Readme Markdown Syntax\u003c/h1\u003e\n\nMarkdown is a syntax for styling all forms of writing on the GitHub platform.\nMostly, it is just regular text with a few non-alphabetic characters thrown in, like ```git # or * ```\n\nYou can use Markdown most places around GitHub:\n\n1. Gists\n2. Comments in Issues and Pull Requests\n3. Files with the .md or .markdown extension\n\n___\n\n### Headers\n\n```git\n# Heading 1\n## Heading 2\n### Heading 3\n#### Heading 4\n##### Heading 5\n###### Heading 6\n```\n\n# Heading 1\n## Heading 2\n### Heading 3\n#### Heading 4\n##### Heading 5\n###### Heading 6\n\n___\n\n### Font\n\n```git\n*Italics*\n_This will also be italic_\n**Bold text**\n__This will also be bold__\n***Bold and Italics***\n_You **can** combine them_\n~~Striked Text~~\n***~~Italic, bold, and strikethrough1~~***\t\n```\n\n*Italics* \u003cbr\u003e\n_This will also be italic_\u003cbr\u003e\n**Bold Text**\u003cbr\u003e\n__This will also be bold__\u003cbr\u003e\n***Bold and Italics***\u003cbr\u003e\n_You **can** combine them_\u003cbr\u003e\n~~Striked Text~~\u003cbr\u003e\n***~~Italic, bold, and strikethrough1~~***\t\n___\n\n### Lists\n\n\u003e Unordered \n\n```git\n* Item 1\n* Item 2\n  * Item 1a\n  * Item 2a\n     * Item 1b\n     * Item 2b\n```\n\n* Item 1\n* Item 2\n  * Item 1a\n  * Item 2a\n     * Item 1b\n     * Item 2b\n\nOR\n`- Item 1`\n- Item 1\n\n\u003e Ordered \n\n```git\n1. First\n2. jhg\n   1. Second\n   2. jhg\n      1. Third\n      2. jhg\n```\n\n1. First\n2. jhg\n   1. Second\n   2. jhg\n      1. Third\n      2. jhg\n\n___\n\n### Links\n\n```git\n* [Link with more info with various formatting options](https://docs.github.com/en/github/writing-on-github \"more info\")\n* https://www.google.com/\n* \u003chttps://www.google.com/\u003e\n```\n\n* [Link with more info with various formatting options](https://docs.github.com/en/github/writing-on-github \"more info\")\n* https://www.google.com/\n* \u003chttps://www.google.com/\u003e\n\n### Link Label \n```git\n[My GitHub][GitHubLink]\n```\n[My GitHub][GitHubLink]\n\nYou may define your link label anywhere in the document.\n```git\ne.g. put on bottom: \n\n--------------------------------\n[GitHubLink]:https://github.com/darsaveli\n```\n\n### Links to the URLs in a repository\n\n```git\n[Example document](/example/example.md)\n```\n\n[Example document](/example/example.md)\n\n```git\n[example](./example)\n```\n\n[example](./example)\n\n___\n\n### Inserting Images or Gifs using links\n\n```git\n![alt](URL \"title\")\n```\n\n- alt in square bracket indicates the replacement text when the image fails to display (can be omitted)\n- parenthesis contains image source\n- title in quotes indicates the text to display when the mouse hovers over the image (can be omitted)\n\nNite: Dropping the image to the readme file will upload it automatically with this syntax;\nIt's the same as links, but add an exlamation mark (!) before opening square bracket;\nImage source can be either a location from the local machine or any valid image URL;\n\n\u003eExample\n\n```git\n![Octocat](https://user-images.githubusercontent.com/81953271/124010886-b571ca80-d9df-11eb-86ac-b358c48ac6aa.png \"Github logo\") \n```\n![Octocat](https://user-images.githubusercontent.com/81953271/124010886-b571ca80-d9df-11eb-86ac-b358c48ac6aa.png \"Github logo\") \n\n### Resize images/Gifs\n```\n\u003cimg src=\"https://github.com/darsaveli/Mariam/blob/main/1479814528_webarebears.gif\" width=\"385px\" align=\"center\"\u003e\n```\n\u003cimg src=\"https://github.com/darsaveli/Mariam/blob/main/1479814528_webarebears.gif\" width=\"385px\" align=\"center\"\u003e\n\nYou can use HTML tags like width=\"385px\", hight=\"876px\", align=\"center\", etc depending what you need. In this case this gif was once uploaded to the repository and the link was taken from there.\n\nOther options to resize: \n- `![](https://  link | width=100)`\n\n___\n\n### Linking Image/Gif\nTo open another webpage when image is clicked, enclose the Markdown for the image in brackets, and then add the link in parentheses.\n\n```\n[![Octocat](https://user-images.githubusercontent.com/81953271/124010886-b571ca80-d9df-11eb-86ac-b358c48ac6aa.png \"GitHub Logo\")](https://github.com/)\n\n```\n\n[![Octocat](https://user-images.githubusercontent.com/81953271/124010886-b571ca80-d9df-11eb-86ac-b358c48ac6aa.png \"GitHub Logo\")](https://github.com/)\n\n___\n\n### Tables\n\n```git\n|Header1|Header2|Header3|\n| --- | --- | --- |\n| This | is a | table |\n| This | is 2nd | row |\n| This | is 3rd | row |\n```\n\n|Header1|Header2|Header3|\n| --- | --- | --- |\n| This | is a | table |\n| This | is 2nd | row |\n| This | is 3rd | row |\n\n### Align\nYou may specify alignment like this:\n```git\n| Align left | Centered  | Align right |\n| :------------ |:---------------:| -----:|\n| col 3 is      | some wordy text | $1600 |\n```\n| Align left | Centered  | Align right |\n| :------------ |:---------------:| -----:|\n| aaa     | bbb | ccc |\n\np.s. You can use alignment with `\u003ch1 (or 2 etc.) align=\"center\"\u003e your text \u003c/h1\u003e` tags or with `\u003cp align=\"center\"\u003e your text\u003c/p\u003e` tag to align plain text. \n___\n\n### CheckBox\n\n```git\n* [ ] Checkbox1\n\n* [ ] Checkbox2\n\n* [x] Checkbox selected\n```\n\n\n* [ ] Checkbox1\n\n* [ ] Checkbox2\n\n* [x] Checkbox selected\n\nYou may use this syntax in GitHub's issue to check or uncheck the checkbox in real time without having to modify the original version of the issue.\n\n___\n\n### Quoting Text\n\n```git\n\u003e This is a block quoted text\n```\n\n\u003e This is a block quoted text\n\n### Multi-level blockquotes\n```\n\u003e Asia\n\u003e\u003e China\n\u003e\u003e\u003e Beijing\n\u003e\u003e\u003e\u003e Haidian\n\u003e\u003e\u003e\u003e\u003e Tsinghua\n```\n#### Look like\n\u003e Asia\n\u003e\u003e China\n\u003e\u003e\u003e Beijing\n\u003e\u003e\u003e\u003e Haidian\n\u003e\u003e\u003e\u003e\u003e Tsinghua\n\n* These are fenced code blocks\n\n___\n\n### Text highlighting\n\n```git\n`linux` `ubuntu`\n```\nUsing a pair of backquotes is suitable for making tags for articles\n`linux` `ubuntu`\n\n___\n\n### Horizontal Line\n\n```git\n***\n___\n--- \n```\n\nAll three will be rendered as:\n___\np.s. \n```git\n\u003chr\u003e works too\n```\n___\n\n### Break between lines\n\n```git\n\u003cbr\u003e\n```\n___\n\n### Visible markdown characters\n \n```git\n```git\n * __ \u003cbr\u003e etc ```\n```\n___\n\n### Multi-line text\n\n    aaa,\n    sss,\n    ddd!\n\nAdd 1 tab or 4 spaces at the beginning of several lines of text.\n\nOR\n\nUse three backticks:\n\n```\nasd,\nsfd,\nwer!\n```\nThis syntax can also be used for code highlighting\n\n___\n\n### Comments in Markdown\n\n```git\n\u003c!-- comment written in markdown --\u003e\n```\nThey will be invisible on readme\n___\n\n### Emoji\n```git\n:grinning:\tor just place the emoji 😀\n```\n:grinning:\tor just place the emoji 😀\n\nTo see a list of every image Github supports, check out the [Emoji Cheat Sheet](https://github.com/ikatyang/emoji-cheat-sheet/blob/master/README.md)\n\n___\n\n### Code Block\nThere are three ways to add code in markdown\n1. Inline Code (single backtick)\n2. Whitespace\n\n```git\n    `this` is an example of inline code.\n```\n    four spaces work too!\n    \n3. Fenced code blocks\nWith GFM you can wrap your code with three back quotes to create a code block without the leading spaces. Add annoptional language identifier and your code will get syntax highlighting.\n\n```Java\npublic static void main(String[]args){} //Java\n```\n\n```javascript\ndocument.getElementById(\"myH1\").innerHTML=\"Welcome to my Homepage\"; //javascipt\n```\n\n___\n\n### Syntax Highlighting\nIf language name is mentioned after the end of first set of backticks, the code snippet will be highlighted according to the language.\n\n    ```js\n    console.log('javascript')\n    ```\n    \n    ```python\n    print('python')\n    ```\n    \n    ```java\n    System.out.println('java')\n    ```\n       \n    ```json\n    {\n      \"firstName\": \"A\",\n      \"lastName\": \"B\n      \"age\": 18\n    }\n    ```\n\n```js\nconsole.log('javascript')\n```\n\n```python\nprint('python')\n```\n\n```java\nSystem.out.println('java')\n```\n\n```json\n{\n  \"firstName\": \"A\",\n  \"lastName\": \"B\",\n  \"age\": 18\n}\n```\n___\n\n### diff syntax\n\nIn the version control system, the function of diff is indispensable, i.e., the addition and deletion of a file content is displayed.\nThe diff effect that can be displayed in GFM. Green is for new, while red is for deleted.\n#### Syntax\nThe syntax is similar to code [fenced code blocks](#fenced-code-blocks), except that the diff is written after the three backticks.\nAnd in the content, the beginning of `+ ` indicates the addition, and the beginning of `- ` indicates the deletion.\n\n```diff\n+ Hello world!\n- This is useless.\n```\n\n___\n\n### Use YAML: human friendly data serialization language for all programming languages\n\n```yaml\nname: Mariam\nlocated_in: ***\nfrom: ***\neducation: ***\njob: ***\ncompany: ***\n```\n___\n\n### Anchor\nIn fact, each title is an anchor, similar to the HTML anchor (`#`), e.g.\n\n|Syntax|Look like|\n|---|---|\n|`[Back to top](#readme)`|[Back to top](#readme)|\n\nNote that all the letters in the title are converted to **lowercase letters**.\n\n___\n\n### Render mathematical expressions in Markdown\n\nYou can now use LaTeX style syntax to render math expressions within Markdown inline (using $ delimiters) or in blocks (using $$ delimiters).\n\nWriting expressions as blocks\nTo add math as a multiline block displayed separately from surrounding text, start a new line and delimit the expression with two dollar symbols $$.\n\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\n\n```git\n$$\\left( \\sum_{k=1}^n a_k b_k \\right)^2 \\leq \\left( \\sum_{k=1}^n a_k^2 \\right) \\left( \\sum_{k=1}^n b_k^2 \\right)$$\n```\n## Writing inline expressions\nTo include a math expression inline with your text, delimit the expression with a dollar symbol $.\n\nThis sentence uses `$` delimiters to show math inline:  $\\sqrt{3x-1}+(1+x)^2$\n\n```git\nThis sentence uses `$` delimiters to show math inline:  $\\sqrt{3x-1}+(1+x)^2$\n```\n\n___\n\n\n### [Markdown posts on GitHub](https://github.blog/changelog/label/markdown/)\n\n___\n\n","funding_links":[],"categories":["markdown","Others","Git Documentation Guides"],"sub_categories":["ReadMe Guides"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarsaveli%2FReadme-Markdown-Syntax","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdarsaveli%2FReadme-Markdown-Syntax","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdarsaveli%2FReadme-Markdown-Syntax/lists"}