├── .gitignore ├── .prettierignore ├── rl.md ├── supported_file_extensions ├── todo.txt ├── documentation.md ├── documentation.markdown ├── pie_chart.mmd ├── pie_chart.mermaid ├── ruby.gif ├── BinaryTree.jpg ├── BinaryTree.png ├── fictional_park.json ├── fictional_park.geojson ├── fictional_park.topojson ├── theultimatemarkdowncheatsheet-brightgreen.svg ├── md.svg ├── solid_cube.stl └── README.md ├── .vscode └── settings.json ├── .github ├── workflows │ └── readme-checker.yml ├── pull_request_template.md └── ISSUE_TEMPLATE │ ├── feature_request.md │ └── bug_report.md ├── .markdownlint.json ├── LICENSE ├── CONTRIBUTING.md ├── MathJax.md └── README.md /.gitignore: -------------------------------------------------------------------------------- 1 | .DS_Store -------------------------------------------------------------------------------- /.prettierignore: -------------------------------------------------------------------------------- 1 | *.md -------------------------------------------------------------------------------- /rl.md: -------------------------------------------------------------------------------- 1 | # Example of a relative link 2 | -------------------------------------------------------------------------------- /supported_file_extensions/todo.txt: -------------------------------------------------------------------------------- 1 | [x] Task 1 2 | [] Task 2 -------------------------------------------------------------------------------- /supported_file_extensions/documentation.md: -------------------------------------------------------------------------------- 1 | # Documentation 2 | -------------------------------------------------------------------------------- /supported_file_extensions/documentation.markdown: -------------------------------------------------------------------------------- 1 | # Documentation 2 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "files.trimTrailingWhitespace": true 3 | } 4 | -------------------------------------------------------------------------------- /supported_file_extensions/pie_chart.mmd: -------------------------------------------------------------------------------- 1 | pie 2 | "Movies" : 80 3 | "TV shows" : 20 4 | -------------------------------------------------------------------------------- /supported_file_extensions/pie_chart.mermaid: -------------------------------------------------------------------------------- 1 | pie 2 | "Movies" : 80 3 | "TV shows" : 20 4 | -------------------------------------------------------------------------------- /supported_file_extensions/ruby.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lifeparticle/Markdown-Cheatsheet/HEAD/supported_file_extensions/ruby.gif -------------------------------------------------------------------------------- /supported_file_extensions/BinaryTree.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lifeparticle/Markdown-Cheatsheet/HEAD/supported_file_extensions/BinaryTree.jpg -------------------------------------------------------------------------------- /supported_file_extensions/BinaryTree.png: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/lifeparticle/Markdown-Cheatsheet/HEAD/supported_file_extensions/BinaryTree.png -------------------------------------------------------------------------------- /.github/workflows/readme-checker.yml: -------------------------------------------------------------------------------- 1 | on: [push, pull_request] 2 | 3 | jobs: 4 | lint: 5 | runs-on: ubuntu-latest 6 | steps: 7 | - uses: actions/checkout@v3 8 | - uses: DavidAnson/markdownlint-cli2-action@v11 9 | with: 10 | config: "./.markdownlint.json" 11 | globs: | 12 | *.md 13 | !test/*.md 14 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | # Pull Request Overview 2 | 3 | Please provide a brief summary of the changes made in this pull request. 4 | This helps reviewers understand the context and intent of your changes. 5 | 6 | ## Changes Introduced 7 | 8 | List specific changes made (e.g., added new or refactored existing syntax). 9 | Include reasons for complex or significant changes 10 | 11 | ## Linked Issue(s) 12 | 13 | - [ ] Link to the issue ticket(s) this PR addresses (e.g., `Fixes #123`) 14 | 15 | ## Additional Notes 16 | 17 | - [ ] Add any other context or notes about the pull request here (optional) 18 | -------------------------------------------------------------------------------- /supported_file_extensions/fictional_park.json: -------------------------------------------------------------------------------- 1 | { 2 | "type": "FeatureCollection", 3 | "features": [ 4 | { 5 | "type": "Feature", 6 | "geometry": { 7 | "type": "Polygon", 8 | "coordinates": [ 9 | [ 10 | [-100.0, 40.0], 11 | [-99.0, 40.0], 12 | [-99.0, 41.0], 13 | [-100.0, 41.0], 14 | [-100.0, 40.0] 15 | ] 16 | ] 17 | }, 18 | "properties": { 19 | "name": "Fictional Park", 20 | "description": "A large, fictional park for demonstration purposes." 21 | } 22 | } 23 | ] 24 | } 25 | -------------------------------------------------------------------------------- /.markdownlint.json: -------------------------------------------------------------------------------- 1 | { 2 | "MD013": { 3 | "line_length": 409, 4 | "code_blocks": false, 5 | "tables": false 6 | }, 7 | "MD033": { 8 | "allowed_elements": [ 9 | "h1", 10 | "h2", 11 | "h3", 12 | "h4", 13 | "h5", 14 | "h6", 15 | "a", 16 | "br", 17 | "kbd", 18 | "strong", 19 | "em", 20 | "blockquote", 21 | "samp", 22 | "strike", 23 | "ins", 24 | "table", 25 | "tr", 26 | "th", 27 | "td", 28 | "sub", 29 | "sup", 30 | "p", 31 | "img", 32 | "pre", 33 | "picture", 34 | "source", 35 | "ul", 36 | "li", 37 | "details", 38 | "summary", 39 | "div" 40 | ] 41 | }, 42 | "MD034": false 43 | } 44 | -------------------------------------------------------------------------------- /supported_file_extensions/fictional_park.geojson: -------------------------------------------------------------------------------- 1 | { 2 | "type": "FeatureCollection", 3 | "features": [ 4 | { 5 | "type": "Feature", 6 | "geometry": { 7 | "type": "Polygon", 8 | "coordinates": [ 9 | [ 10 | [-100.0, 40.0], 11 | [-99.0, 40.0], 12 | [-99.0, 41.0], 13 | [-100.0, 41.0], 14 | [-100.0, 40.0] 15 | ] 16 | ] 17 | }, 18 | "properties": { 19 | "name": "Fictional Park", 20 | "description": "A large, fictional park for demonstration purposes." 21 | } 22 | } 23 | ] 24 | } 25 | -------------------------------------------------------------------------------- /supported_file_extensions/fictional_park.topojson: -------------------------------------------------------------------------------- 1 | { 2 | "type": "Topology", 3 | "objects": { 4 | "fictional_park": { 5 | "type": "GeometryCollection", 6 | "geometries": [ 7 | { 8 | "type": "Polygon", 9 | "arcs": [[0]], 10 | "properties": { 11 | "name": "Fictional Park", 12 | "description": "A large, fictional park for demonstration purposes." 13 | } 14 | } 15 | ] 16 | } 17 | }, 18 | "arcs": [ 19 | [[-100, 40], [-99, 40], [-99, 41], [-100, 41], [-100, 40]] 20 | ], 21 | "transform": { 22 | "scale": [0.0001, 0.0001], 23 | "translate": [-100, 40] 24 | } 25 | } 26 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always 12 | frustrated when [...] 13 | 14 | **Describe the solution you'd like** 15 | A clear and concise description of what you want to happen. 16 | 17 | **Describe alternatives you've considered** 18 | A clear and concise description of any alternative solutions or features you've 19 | considered. 20 | 21 | **Additional context** 22 | Add any other context or screenshots about the feature request here. 23 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Steps to reproduce the behavior: 15 | 16 | 1. Go to '...' 17 | 2. Click on '....' 18 | 3. Scroll down to '....' 19 | 4. See error 20 | 21 | **Expected behavior** 22 | A clear and concise description of what you expected to happen. 23 | 24 | **Screenshots** 25 | If applicable, add screenshots to help explain your problem. 26 | 27 | **Desktop (please complete the following information):** 28 | 29 | - OS: [e.g. iOS] 30 | - Browser [e.g. chrome, safari] 31 | - Version [e.g. 22] 32 | 33 | **Smartphone (please complete the following information):** 34 | 35 | - Device: [e.g. iPhone6] 36 | - OS: [e.g. iOS8.1] 37 | - Browser [e.g. stock browser, safari] 38 | - Version [e.g. 22] 39 | 40 | **Additional context** 41 | Add any other context about the problem here. 42 | -------------------------------------------------------------------------------- /supported_file_extensions/theultimatemarkdowncheatsheet-brightgreen.svg: -------------------------------------------------------------------------------- 1 | theultimatemarkdowncheatsheettheultimatemarkdowncheatsheet -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2021 Mahbub Zaman 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /supported_file_extensions/md.svg: -------------------------------------------------------------------------------- 1 | 2 | 3 |
4 | 38 |
39 | Markdown-Cheatsheet 40 |
41 |
42 | 43 | 44 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contribution Guidelines 2 | 3 | 1. Fork the repo 4 | 2. Clone your fork 5 | 3. Sync your local master 6 | 7 | 3.1. 8 | 9 | ```bash 10 | git remote add upstream git@github.com:lifeparticle/Markdown-Cheatsheet.git 11 | ``` 12 | 13 | 3.2. 14 | 15 | ```bash 16 | git fetch upstream 17 | ``` 18 | 19 | 3.3. 20 | 21 | ```bash 22 | git branch --set-upstream-to=upstream/main main 23 | ``` 24 | 25 | 3.4. 26 | 27 | ```bash 28 | git pull 29 | ``` 30 | 31 | 4. Create a branch 32 | 33 | ```bash 34 | git branch issue-2 # use issue_number, replace issue-2 with appropriate branch name 35 | git checkout issue-2 36 | ``` 37 | 38 | 5. Run lint 39 | 40 | ```shell 41 | markdownlint-cli2 "**/*.md" --config ./.markdownlint.json 42 | ``` 43 | 44 | 6. Push your changes to your fork with git push 45 | 46 | ```bash 47 | git add . 48 | git commit -m"Write a meaningfull commit message" 49 | git push 50 | ``` 51 | 52 | 7. Create a pull request 53 | 54 | 7.1 Use the url from the terminal 55 | 56 | ```bash 57 | remote: Create a pull request for 'issue-2' on GitHub by visiting: 58 | remote: https://github.com/........................ 59 | ``` 60 | 61 | 7.2 If you're haveing problem finding the url 62 | 63 | a) [Markdown-Cheatsheet Pull requests](https://github.com/lifeparticle/Markdown-Cheatsheet/pulls) 64 | 65 | b) Click the button 'New pull request' 66 | 67 | c) Click the link 'compare acorss forks' 68 | 69 | d) Change head repository to your fork 70 | 71 | e) Change the branch to your branch 72 | 73 | f) Create pull request 74 | 75 | 8. Repeat 76 | 77 | ```bash 78 | git checkout master 79 | git pull 80 | ``` 81 | -------------------------------------------------------------------------------- /supported_file_extensions/solid_cube.stl: -------------------------------------------------------------------------------- 1 | solid cube 2 | facet normal 0 0 0 3 | outer loop 4 | vertex 0 0 0 5 | vertex 1 0 0 6 | vertex 1 1 0 7 | endloop 8 | endfacet 9 | facet normal 0 0 0 10 | outer loop 11 | vertex 0 0 0 12 | vertex 1 1 0 13 | vertex 0 1 0 14 | endloop 15 | endfacet 16 | facet normal 0 0 0 17 | outer loop 18 | vertex 0 0 1 19 | vertex 1 0 1 20 | vertex 1 1 1 21 | endloop 22 | endfacet 23 | facet normal 0 0 0 24 | outer loop 25 | vertex 0 0 1 26 | vertex 1 1 1 27 | vertex 0 1 1 28 | endloop 29 | endfacet 30 | facet normal 0 0 0 31 | outer loop 32 | vertex 0 0 0 33 | vertex 0 1 0 34 | vertex 0 1 1 35 | endloop 36 | endfacet 37 | facet normal 0 0 0 38 | outer loop 39 | vertex 0 0 0 40 | vertex 0 1 1 41 | vertex 0 0 1 42 | endloop 43 | endfacet 44 | facet normal 0 0 0 45 | outer loop 46 | vertex 1 0 0 47 | vertex 1 1 0 48 | vertex 1 1 1 49 | endloop 50 | endfacet 51 | facet normal 0 0 0 52 | outer loop 53 | vertex 1 0 0 54 | vertex 1 1 1 55 | vertex 1 0 1 56 | endloop 57 | endfacet 58 | facet normal 0 0 0 59 | outer loop 60 | vertex 0 0 0 61 | vertex 0 0 1 62 | vertex 1 0 1 63 | endloop 64 | endfacet 65 | facet normal 0 0 0 66 | outer loop 67 | vertex 0 0 0 68 | vertex 1 0 1 69 | vertex 1 0 0 70 | endloop 71 | endfacet 72 | facet normal 0 0 0 73 | outer loop 74 | vertex 0 1 0 75 | vertex 0 1 1 76 | vertex 1 1 1 77 | endloop 78 | endfacet 79 | facet normal 0 0 0 80 | outer loop 81 | vertex 0 1 0 82 | vertex 1 1 1 83 | vertex 1 1 0 84 | endloop 85 | endfacet 86 | endsolid cube 87 | -------------------------------------------------------------------------------- /supported_file_extensions/README.md: -------------------------------------------------------------------------------- 1 | # Supported file extensions 2 | 3 | | Content Type | Supported Extensions | Description | 4 | |--------------|----------------------------------------------------------------------------|-------------------------------------------| 5 | | mermaid | [.mermaid](./pie_chart.mermaid), [.mmd](./pie_chart.mmd) | Diagramming and charting tool | 6 | | geoJSON | [.geojson](./fictional_park.geojson), [.json](./fictional_park.json) | Format for encoding geographic data | 7 | | topoJSON | [.topojson](./fictional_park.topojson), .json | Extension of GeoJSON for topology data | 8 | | STL | [.stl](./solid_cube.stl) | File format for 3D models | 9 | | Markdown | [.markdown](./documentation.markdown), [.md](./documentation.md) | Markup language for formatting text | 10 | | SVG | [.svg](./theultimatemarkdowncheatsheet-brightgreen.svg), [.svg](./md.svg) | Scalable Vector Graphics file format | 11 | | PNG | [.png](./BinaryTree.png) | Portable Network Graphics file format | 12 | | GIF | [.gif](./ruby.gif) | Graphics Interchange Format file | 13 | | JPEG | [.jpg](./BinaryTree.jpg), .jpeg | JPEG image file format | 14 | | Text | [.txt](./todo.txt) | Plain text file | 15 | 16 | ## mermaid 17 | 18 | ```mermaid 19 | pie 20 | "Movies" : 80 21 | "TV shows" : 20 22 | ``` 23 | 24 | ````md 25 | ```mermaid 26 | pie 27 | "Movies" : 80 28 | "TV shows" : 20 29 | ``` 30 | ```` 31 | 32 | ## geoJSON 33 | 34 | ```geojson 35 | { 36 | "type": "FeatureCollection", 37 | "features": [ 38 | { 39 | "type": "Feature", 40 | "geometry": { 41 | "type": "Polygon", 42 | "coordinates": [ 43 | [ 44 | [-100.0, 40.0], 45 | [-99.0, 40.0], 46 | [-99.0, 41.0], 47 | [-100.0, 41.0], 48 | [-100.0, 40.0] 49 | ] 50 | ] 51 | }, 52 | "properties": { 53 | "name": "Fictional Park", 54 | "description": "A large, fictional park for demonstration purposes." 55 | } 56 | } 57 | ] 58 | } 59 | ``` 60 | 61 | ````md 62 | ```geojson 63 | { 64 | "type": "FeatureCollection", 65 | "features": [ 66 | { 67 | "type": "Feature", 68 | "geometry": { 69 | "type": "Polygon", 70 | "coordinates": [ 71 | [ 72 | [-100.0, 40.0], 73 | [-99.0, 40.0], 74 | [-99.0, 41.0], 75 | [-100.0, 41.0], 76 | [-100.0, 40.0] 77 | ] 78 | ] 79 | }, 80 | "properties": { 81 | "name": "Fictional Park", 82 | "description": "A large, fictional park for demonstration purposes." 83 | } 84 | } 85 | ] 86 | } 87 | ``` 88 | ```` 89 | 90 | ## topoJSON 91 | 92 | ```topojson 93 | { 94 | "type": "Topology", 95 | "objects": { 96 | "fictional_park": { 97 | "type": "GeometryCollection", 98 | "geometries": [ 99 | { 100 | "type": "Polygon", 101 | "arcs": [[0]], 102 | "properties": { 103 | "name": "Fictional Park", 104 | "description": "A large, fictional park for demonstration purposes." 105 | } 106 | } 107 | ] 108 | } 109 | }, 110 | "arcs": [ 111 | [[-100, 40], [-99, 40], [-99, 41], [-100, 41], [-100, 40]] 112 | ], 113 | "transform": { 114 | "scale": [0.0001, 0.0001], 115 | "translate": [-100, 40] 116 | } 117 | } 118 | ``` 119 | 120 | ````md 121 | ```topojson 122 | { 123 | "type": "Topology", 124 | "objects": { 125 | "fictional_park": { 126 | "type": "GeometryCollection", 127 | "geometries": [ 128 | { 129 | "type": "Polygon", 130 | "arcs": [[0]], 131 | "properties": { 132 | "name": "Fictional Park", 133 | "description": "A large, fictional park for demonstration purposes." 134 | } 135 | } 136 | ] 137 | } 138 | }, 139 | "arcs": [ 140 | [[-100, 40], [-99, 40], [-99, 41], [-100, 41], [-100, 40]] 141 | ], 142 | "transform": { 143 | "scale": [0.0001, 0.0001], 144 | "translate": [-100, 40] 145 | } 146 | } 147 | ``` 148 | ```` 149 | 150 | ## STL 151 | 152 | ```stl 153 | solid cube 154 | facet normal 0 0 0 155 | outer loop 156 | vertex 0 0 0 157 | vertex 1 0 0 158 | vertex 1 1 0 159 | endloop 160 | endfacet 161 | facet normal 0 0 0 162 | outer loop 163 | vertex 0 0 0 164 | vertex 1 1 0 165 | vertex 0 1 0 166 | endloop 167 | endfacet 168 | facet normal 0 0 0 169 | outer loop 170 | vertex 0 0 1 171 | vertex 1 0 1 172 | vertex 1 1 1 173 | endloop 174 | endfacet 175 | facet normal 0 0 0 176 | outer loop 177 | vertex 0 0 1 178 | vertex 1 1 1 179 | vertex 0 1 1 180 | endloop 181 | endfacet 182 | facet normal 0 0 0 183 | outer loop 184 | vertex 0 0 0 185 | vertex 0 1 0 186 | vertex 0 1 1 187 | endloop 188 | endfacet 189 | facet normal 0 0 0 190 | outer loop 191 | vertex 0 0 0 192 | vertex 0 1 1 193 | vertex 0 0 1 194 | endloop 195 | endfacet 196 | facet normal 0 0 0 197 | outer loop 198 | vertex 1 0 0 199 | vertex 1 1 0 200 | vertex 1 1 1 201 | endloop 202 | endfacet 203 | facet normal 0 0 0 204 | outer loop 205 | vertex 1 0 0 206 | vertex 1 1 1 207 | vertex 1 0 1 208 | endloop 209 | endfacet 210 | facet normal 0 0 0 211 | outer loop 212 | vertex 0 0 0 213 | vertex 0 0 1 214 | vertex 1 0 1 215 | endloop 216 | endfacet 217 | facet normal 0 0 0 218 | outer loop 219 | vertex 0 0 0 220 | vertex 1 0 1 221 | vertex 1 0 0 222 | endloop 223 | endfacet 224 | facet normal 0 0 0 225 | outer loop 226 | vertex 0 1 0 227 | vertex 0 1 1 228 | vertex 1 1 1 229 | endloop 230 | endfacet 231 | facet normal 0 0 0 232 | outer loop 233 | vertex 0 1 0 234 | vertex 1 1 1 235 | vertex 1 1 0 236 | endloop 237 | endfacet 238 | endsolid cube 239 | ``` 240 | 241 | ````md 242 | ```stl 243 | solid cube 244 | facet normal 0 0 0 245 | outer loop 246 | vertex 0 0 0 247 | vertex 1 0 0 248 | vertex 1 1 0 249 | endloop 250 | endfacet 251 | facet normal 0 0 0 252 | outer loop 253 | vertex 0 0 0 254 | vertex 1 1 0 255 | vertex 0 1 0 256 | endloop 257 | endfacet 258 | facet normal 0 0 0 259 | outer loop 260 | vertex 0 0 1 261 | vertex 1 0 1 262 | vertex 1 1 1 263 | endloop 264 | endfacet 265 | facet normal 0 0 0 266 | outer loop 267 | vertex 0 0 1 268 | vertex 1 1 1 269 | vertex 0 1 1 270 | endloop 271 | endfacet 272 | facet normal 0 0 0 273 | outer loop 274 | vertex 0 0 0 275 | vertex 0 1 0 276 | vertex 0 1 1 277 | endloop 278 | endfacet 279 | facet normal 0 0 0 280 | outer loop 281 | vertex 0 0 0 282 | vertex 0 1 1 283 | vertex 0 0 1 284 | endloop 285 | endfacet 286 | facet normal 0 0 0 287 | outer loop 288 | vertex 1 0 0 289 | vertex 1 1 0 290 | vertex 1 1 1 291 | endloop 292 | endfacet 293 | facet normal 0 0 0 294 | outer loop 295 | vertex 1 0 0 296 | vertex 1 1 1 297 | vertex 1 0 1 298 | endloop 299 | endfacet 300 | facet normal 0 0 0 301 | outer loop 302 | vertex 0 0 0 303 | vertex 0 0 1 304 | vertex 1 0 1 305 | endloop 306 | endfacet 307 | facet normal 0 0 0 308 | outer loop 309 | vertex 0 0 0 310 | vertex 1 0 1 311 | vertex 1 0 0 312 | endloop 313 | endfacet 314 | facet normal 0 0 0 315 | outer loop 316 | vertex 0 1 0 317 | vertex 0 1 1 318 | vertex 1 1 1 319 | endloop 320 | endfacet 321 | facet normal 0 0 0 322 | outer loop 323 | vertex 0 1 0 324 | vertex 1 1 1 325 | vertex 1 1 0 326 | endloop 327 | endfacet 328 | endsolid cube 329 | ``` 330 | ```` 331 | 332 | ## Markdown 333 | 334 | **It works.** 335 | 336 | ```md 337 | **It works.** 338 | ``` 339 | 340 | ## SVG 341 | 342 | Green button with the text 'theultimatemarkdowncheatsheet' in white letters. 343 | 344 | ```md 345 | Green button with the text 'theultimatemarkdowncheatsheet' in white letters. 346 | ``` 347 | 348 | SVG Animation 349 | 350 | Animated SVG of the text 'Markdown-Cheatsheet' in white letters. 351 | 352 | ```md 353 | Animated SVG of the text 'Markdown-Cheatsheet' in white letters. 354 | ``` 355 | 356 | ## PNG 357 | 358 | Logo of BinaryTree featuring a hexagonal icon. 359 | 360 | ```md 361 | Logo of BinaryTree featuring a hexagonal icon. 362 | ``` 363 | 364 | ## GIF 365 | 366 | A terminal screen displaying the Interactive Ruby (irb) environment. 367 | 368 | ```md 369 | A terminal screen displaying the Interactive Ruby (irb) environment. 370 | ``` 371 | 372 | ## JPEG 373 | 374 | Logo of BinaryTree featuring a hexagonal icon and the text 'BINARY TREE' in capital letters to the right of the icon. 375 | 376 | ```md 377 | Logo of BinaryTree featuring a hexagonal icon and the text 'BINARY TREE' in capital letters to the right of the icon. 378 | ``` 379 | 380 | ## Text 381 | 382 | ```txt 383 | [x] Task 1 384 | [] Task 2 385 | ``` 386 | 387 | ````md 388 | ```txt 389 | [x] Task 1 390 | [] Task 2 391 | ``` 392 | ```` 393 | -------------------------------------------------------------------------------- /MathJax.md: -------------------------------------------------------------------------------- 1 | # Text Color 2 | 3 | Using MathJax syntax: 4 | 5 | | Color Name | Code | Example | 6 | |-----------------|----------------------------------------------------------------------------------------------|----------------------------------------------------------------| 7 | | Apricot | `$\color{Apricot}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Apricot}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 8 | | Aquamarine | `$\color{Aquamarine}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Aquamarine}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 9 | | Bittersweet | `$\color{Bittersweet}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Bittersweet}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 10 | | Black | `$\color{Black}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Black}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 11 | | Blue | `$\color{Blue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Blue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 12 | | BlueGreen | `$\color{BlueGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{BlueGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 13 | | BlueViolet | `$\color{BlueViolet}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{BlueViolet}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 14 | | BrickRed | `$\color{BrickRed}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{BrickRed}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 15 | | Brown | `$\color{Brown}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Brown}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 16 | | BurntOrange | `$\color{BurntOrange}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{BurntOrange}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 17 | | CadetBlue | `$\color{CadetBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{CadetBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 18 | | CarnationPink | `$\color{CarnationPink}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{CarnationPink}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$| 19 | | Cerulean | `$\color{Cerulean}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Cerulean}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 20 | | CornflowerBlue | `$\color{CornflowerBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{CornflowerBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$| 21 | | Cyan | `$\color{Cyan}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Cyan}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 22 | | Dandelion | `$\color{Dandelion}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Dandelion}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 23 | | DarkOrchid | `$\color{DarkOrchid}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{DarkOrchid}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 24 | | Emerald | `$\color{Emerald}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Emerald}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 25 | | ForestGreen | `$\color{ForestGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{ForestGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$| 26 | | Fuchsia | `$\color{Fuchsia}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Fuchsia}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 27 | | Goldenrod | `$\color{Goldenrod}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Goldenrod}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 28 | | Gray | `$\color{Gray}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Gray}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 29 | | Green | `$\color{Green}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Green}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 30 | | GreenYellow | `$\color{GreenYellow}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{GreenYellow}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$| 31 | | JungleGreen | `$\color{JungleGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{JungleGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$| 32 | | Lavender | `$\color{Lavender}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Lavender}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 33 | | LimeGreen | `$\color{LimeGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{LimeGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 34 | | Magenta | `$\color{Magenta}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Magenta}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 35 | | Mahogany | `$\color{Mahogany}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Mahogany}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 36 | | Maroon | `$\color{Maroon}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Maroon}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 37 | | Melon | `$\color{Melon}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Melon}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 38 | | MidnightBlue | `$\color{MidnightBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{MidnightBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 39 | | Mulberry | `$\color{Mulberry}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Mulberry}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 40 | | NavyBlue | `$\color{NavyBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{NavyBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 41 | | OliveGreen | `$\color{OliveGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{OliveGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 42 | | Orange | `$\color{Orange}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Orange}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 43 | | OrangeRed | `$\color{OrangeRed}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{OrangeRed}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 44 | | Orchid | `$\color{Orchid}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Orchid}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 45 | | Peach | `$\color{Peach}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Peach}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 46 | | Periwinkle | `$\color{Periwinkle}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Periwinkle}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 47 | | PineGreen | `$\color{PineGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{PineGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 48 | | Plum | `$\color{Plum}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Plum}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 49 | | ProcessBlue | `$\color{ProcessBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{ProcessBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 50 | | Purple | `$\color{Purple}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Purple}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 51 | | RawSienna | `$\color{RawSienna}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{RawSienna}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 52 | | Red | `$\color{Red}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Red}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 53 | | RedOrange | `$\color{RedOrange}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{RedOrange}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 54 | | RedViolet | `$\color{RedViolet}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{RedViolet}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 55 | | Rhodamine | `$\color{Rhodamine}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Rhodamine}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 56 | | RoyalBlue | `$\color{RoyalBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{RoyalBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 57 | | RoyalPurple | `$\color{RoyalPurple}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{RoyalPurple}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 58 | | RubineRed | `$\color{RubineRed}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{RubineRed}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 59 | | Salmon | `$\color{Salmon}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Salmon}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 60 | | SeaGreen | `$\color{SeaGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{SeaGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 61 | | Sepia | `$\color{Sepia}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Sepia}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 62 | | SkyBlue | `$\color{SkyBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{SkyBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 63 | | SpringGreen | `$\color{SpringGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{SpringGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 64 | | Tan | `$\color{Tan}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Tan}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 65 | | TealBlue | `$\color{TealBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{TealBlue}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 66 | | Thistle | `$\color{Thistle}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Thistle}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 67 | | Turquoise | `$\color{Turquoise}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Turquoise}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 68 | | Violet | `$\color{Violet}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Violet}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 69 | | VioletRed | `$\color{VioletRed}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{VioletRed}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 70 | | White | `$\color{White}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{White}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 71 | | WildStrawberry | `$\color{WildStrawberry}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{WildStrawberry}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 72 | | Yellow | `$\color{Yellow}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Yellow}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 73 | | YellowGreen | `$\color{YellowGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{YellowGreen}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 74 | | YellowOrange | `$\color{YellowOrange}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{YellowOrange}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$| 75 | 76 | [Source](https://en.wikibooks.org/wiki/LaTeX/Colors#Adding_the_color_package) 77 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 |

2 | :black_circle: The Ultimate Markdown Cheat Sheet :black_circle: 3 |

4 | 5 |
6 | 7 | 8 | .github/workflows/readme-checker.yml 9 | 10 | 11 |
12 | 13 | 14 | 15 |
16 | 17 | > [!IMPORTANT] 18 | > Check out the official documentation on [GitHub](https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax) to learn more about writing and formatting syntax. Additionally, you can read the latest updates and features on Markdown by visiting the [GitHub blog](https://github.blog/tag/markdown/). 19 | 20 | For hands-on learning: 21 | 22 | > [!TIP] 23 | > Explore the module on [Microsoft Learn](https://learn.microsoft.com/en-us/training/modules/communicate-using-markdown/). 24 | 25 | - [Introduction](#introduction) 26 | - [Headings](#headings) 27 | - [Text styles](#text-styles) 28 | - [Normal](#normal) 29 | - [Bold](#bold) 30 | - [Italic](#italic) 31 | - [Bold and Italic](#bold-and-italic) 32 | - [Blockquotes](#blockquotes) 33 | - [Monospaced](#monospaced) 34 | - [Underlined](#underlined) 35 | - [Strike-through](#strike-through) 36 | - [Boxed](#boxed) 37 | - [Subscript](#subscript) 38 | - [Superscript](#superscript) 39 | - [Small Text](#small-text) 40 | - [Text Color](#text-color) 41 | - [Multiline](#multiline) 42 | - [Syntax Highlighting](#syntax-highlighting) 43 | - [Inline code](#inline-code) 44 | - [Code block](#code-block) 45 | - [Diff Code block](#diff-code-block) 46 | - [Alignments](#alignments) 47 | - [Tables](#tables) 48 | - [Links](#links) 49 | - [Inline](#inline) 50 | - [Reference](#reference) 51 | - [Footnote](#footnote) 52 | - [Relative](#relative) 53 | - [Auto](#auto) 54 | - [Section](#section) 55 | - [Hover](#hover) 56 | - [Enclosed](#enclosed) 57 | - [Highlight words and link it to a URL](#highlight-words-and-link-it-to-a-url) 58 | - [Images](#images) 59 | - [Theme](#theme) 60 | - [Using picture tag](#using-picture-tag) 61 | - [Using dark and light mode](#using-dark-and-light-mode) 62 | - [Group](#group) 63 | - [Badges](#badges) 64 | - [Videos](#videos) 65 | - [Lists](#lists) 66 | - [Ordered](#ordered) 67 | - [Unordered](#unordered) 68 | - [Task](#task) 69 | - [Buttons](#buttons) 70 | - [Button with emoji](#button-with-emoji) 71 | - [Collapsible items (28 July 2023)](#collapsible-items-28-july-2023) 72 | - [Horizontal Rule](#horizontal-rule) 73 | - [Diagrams (19 July 2022)](#diagrams-19-july-2022) 74 | - [Mathematical expressions (19 July 2022)](#mathematical-expressions-19-july-2022) 75 | - [Alerts (8 January 2024)](#alerts-8-january-2024) 76 | - [Mention people and teams](#mention-people-and-teams) 77 | - [Reference issues and pull requests](#reference-issues-and-pull-requests) 78 | - [Color models](#color-models) 79 | - [View Code](#view-code) 80 | - [Code in titles](#code-in-titles) 81 | - [Reference Labels](#reference-labels) 82 | - [Miscellaneous](#miscellaneous) 83 | - [Comments](#comments) 84 | - [Escaping Markdown Characters](#escaping-markdown-characters) 85 | - [Emojis](#emojis) 86 | - [Line break](#line-break) 87 | - [Back to top](#back-to-top) 88 | - [Bitbucket](#bitbucket) 89 | - [Azure DevOps Project wiki](#azure-devops-project-wiki) 90 | - [MDX](#mdx) 91 | - [Tools](#tools) 92 | 93 | # Introduction 94 | 95 | Markdown is a way of writing rich-text (formatted text) content using plain text formatting syntax. It is also a tool that converts the plain text formatting to HTML. 96 | 97 | - **2004:** [John Gruber](https://daringfireball.net/projects/markdown/) developed Markdown. 98 | - **2014:** [CommonMark](https://commonmark.org/) was established as a standard specification for Markdown to resolve inconsistencies and ambiguities in Markdown implementations. This initiative was spearheaded by [John MacFarlane](https://github.com/jgm) and backed by other Markdown enthusiasts to ensure a reliable and consistent specification. 99 | 100 | This guide will provide you with a comprehensive understanding of the key commands in [GitHub Flavored Markdown (GFM)](https://github.github.com/gfm/), it is a strict superset of CommonMark. You can read the full article, [The Ultimate Markdown Cheat Sheet](https://towardsdatascience.com/the-ultimate-markdown-cheat-sheet-3d3976b31a0) on Medium. 101 | 102 | # Headings 103 | 104 | ```md 105 | # Heading 1 106 | ## Heading 2 107 | ### Heading 3 108 | #### Heading 4 109 | ##### Heading 5 110 | ###### Heading 6 111 | ``` 112 | 113 | # Heading 1 114 | 115 | ## Heading 2 116 | 117 | ### Heading 3 118 | 119 | #### Heading 4 120 | 121 | ##### Heading 5 122 | 123 | ###### Heading 6 124 | 125 | ```md 126 |

Heading 1

127 |

Heading 2

128 |

Heading 3

129 |

Heading 4

130 |
Heading 5
131 |
Heading 6
132 | ``` 133 | 134 | 135 |

Heading 1

136 | 137 |

Heading 2

138 | 139 |

Heading 3

140 | 141 |

Heading 4

142 | 143 |
Heading 5
144 | 145 |
Heading 6
146 | 147 | ```md 148 | Heading 1 149 | = 150 | Heading 2 151 | - 152 | ``` 153 | 154 | 155 | Heading 1 156 | = 157 | 158 | Heading 2 159 | - 160 | 161 | # Text styles 162 | 163 | ## Normal 164 | 165 | ```md 166 | The quick brown fox jumps over the lazy dog. 167 | ``` 168 | 169 | The quick brown fox jumps over the lazy dog. 170 | 171 | ## Bold 172 | 173 | Mac: command+B 174 | 175 | Windows: control+B 176 | 177 | ```md 178 | **The quick brown fox jumps over the lazy dog.** 179 | __The quick brown fox jumps over the lazy dog.__ 180 | The quick brown fox jumps over the lazy dog. 181 | ``` 182 | 183 | **The quick brown fox jumps over the lazy dog.** 184 | 185 | 186 | __The quick brown fox jumps over the lazy dog.__ 187 | 188 | The quick brown fox jumps over the lazy dog. 189 | 190 | ## Italic 191 | 192 | Mac: command+I 193 | 194 | Windows: control+I 195 | 196 | ```md 197 | *The quick brown fox jumps over the lazy dog.* 198 | _The quick brown fox jumps over the lazy dog._ 199 | The quick brown fox jumps over the lazy dog. 200 | ``` 201 | 202 | *The quick brown fox jumps over the lazy dog.* 203 | 204 | 205 | _The quick brown fox jumps over the lazy dog._ 206 | 207 | The quick brown fox jumps over the lazy dog. 208 | 209 | ## Bold and Italic 210 | 211 | ```md 212 | **_The quick brown fox jumps over the lazy dog._** 213 | ***The quick brown fox jumps over the lazy dog.*** 214 | The quick brown fox jumps over the lazy dog. 215 | ``` 216 | 217 | **_The quick brown fox jumps over the lazy dog._** 218 | 219 | ***The quick brown fox jumps over the lazy dog.*** 220 | 221 | The quick brown fox jumps over the lazy dog. 222 | 223 | ## Blockquotes 224 | 225 | Mac: command+shift+. 226 | 227 | Windows: control+shift+. 228 | 229 | ```md 230 | > The quick brown fox jumps over the lazy dog. 231 | 232 |
233 | 234 | > The quick brown fox jumps over the lazy dog. 235 | > 236 | > The quick brown fox jumps over the lazy dog. 237 | > 238 | > The quick brown fox jumps over the lazy dog. 239 | 240 |
241 | 242 | > The quick brown fox jumps over the lazy dog. 243 | >> The quick brown fox jumps over the lazy dog. 244 | >>> The quick brown fox jumps over the lazy dog. 245 | 246 |
247 | 248 | > **The quick brown fox** *jumps over the lazy dog.* 249 | ``` 250 | 251 | > The quick brown fox jumps over the lazy dog. 252 | 253 |
254 | 255 | > The quick brown fox jumps over the lazy dog. 256 | > 257 | > The quick brown fox jumps over the lazy dog. 258 | > 259 | > The quick brown fox jumps over the lazy dog. 260 | 261 |
262 | 263 | > The quick brown fox jumps over the lazy dog. 264 | >> The quick brown fox jumps over the lazy dog. 265 | >>> The quick brown fox jumps over the lazy dog. 266 | 267 |
268 | 269 | > **The quick brown fox** *jumps over the lazy dog.* 270 | 271 | ## Monospaced 272 | 273 | ```md 274 | The quick brown fox jumps over the lazy dog. 275 | ``` 276 | 277 | The quick brown fox jumps over the lazy dog. 278 | 279 | ## Underlined 280 | 281 | ```md 282 | The quick brown fox jumps over the lazy dog. 283 | ``` 284 | 285 | The quick brown fox jumps over the lazy dog. 286 | 287 | ## Strike-through 288 | 289 | ```md 290 | ~~The quick brown fox jumps over the lazy dog.~~ 291 | ``` 292 | 293 | ~~The quick brown fox jumps over the lazy dog.~~ 294 | 295 | ```md 296 | 
 297 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna
 298 | aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
 299 | Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint
 300 | occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 301 |
302 | ``` 303 | 304 | 
 305 | Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna
 306 | aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
 307 | Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint
 308 | occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.
 309 |
310 | 311 | ````md 312 | 313 | 314 | ```js 315 | console.log('Error'); 316 | ``` 317 | 318 | 319 | ```` 320 | 321 | 322 | 323 | ```js 324 | console.log('Error'); 325 | ``` 326 | 327 | 328 | 329 | ## Boxed 330 | 331 | ```md 332 |
The quick brown fox jumps over the lazy dog.
333 | ``` 334 | 335 |
The quick brown fox jumps over the lazy dog.
336 | 337 | ## Subscript 338 | 339 | ```md 340 | log2(x) 341 | Subscript The quick brown fox jumps over the lazy dog. 342 | ``` 343 | 344 | log2(x) 345 | 346 | Subscript The quick brown fox jumps over the lazy dog. 347 | 348 | ## Superscript 349 | 350 | ```md 351 | 2 53-1 and -2 53-1 352 | Superscript The quick brown fox jumps over the lazy dog. 353 | ``` 354 | 355 | 2 53-1 and -2 53-1 356 | 357 | Superscript The quick brown fox jumps over the lazy dog. 358 | 359 | ## Small Text 360 | 361 | Start The quick brown fox jumps over the lazy dog. End 362 | 363 | Start The quick brown fox jumps over the lazy dog. End 364 | 365 | ```md 366 | Start The quick brown fox jumps over the lazy dog. End 367 | 368 | Start The quick brown fox jumps over the lazy dog. End 369 | ``` 370 | 371 | ## Text Color 372 | 373 | Using [MathJax](#mathematical-expressions-19-july-2022) syntax: 374 | 375 | | Color Name | Code | Example | 376 | |-----------------|----------------------------------------------------------------------------------------------|----------------------------------------------------------------| 377 | | Apricot | `$\color{Apricot}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Apricot}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 378 | | Aquamarine | `$\color{Aquamarine}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Aquamarine}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 379 | | Bittersweet | `$\color{Bittersweet}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Bittersweet}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 380 | | Black | `$\color{Black}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$` | $\color{Black}{The\ quick\ brown\ fox\ jumps\ over\ the\ lazy\ dog.}$ | 381 | 382 | [Full Table](./MathJax.md) 383 | 384 | ## Multiline 385 | 386 | The quick\ 387 | brown fox\ 388 | jumps over\ 389 | the lazy dog. 390 | 391 | ```md 392 | The quick\ 393 | brown fox\ 394 | jumps over\ 395 | the lazy dog. 396 | ``` 397 | 398 | # Syntax Highlighting 399 | 400 | ## Inline code 401 | 402 | A class method is an instance method of the class object. When a new class is created, an object of type `Class` is initialized and assigned to a global constant (Mobile in this case). 403 | 404 | You can use command + e on Mac or control + e on Windows to insert inline code. 405 | 406 | ## Code block 407 | 408 | 409 | 410 | ``` 411 | public static String monthNames[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"}; 412 | ``` 413 | 414 | 415 | 416 | ````md 417 | ``` 418 | public static String monthNames[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"}; 419 | ``` 420 | ```` 421 | 422 | ```java 423 | public static String monthNames[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"}; 424 | ``` 425 | 426 | ````md 427 | ```java 428 | public static String monthNames[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"}; 429 | ``` 430 | ```` 431 | 432 | Refer to [this](https://github.com/github-linguist/linguist/blob/master/lib/linguist/languages.yml) and [this](https://github.com/github-linguist/linguist/tree/master/vendor) GitHub document to find all the valid keywords. 433 | 434 | ## Diff Code block 435 | 436 | ```diff 437 | ## git diff a/test.txt b/test.txt 438 | diff --git a/a/test.txt b/b/test.txt 439 | index 309ee57..c995021 100644 440 | --- a/a/test.txt 441 | +++ b/b/test.txt 442 | @@ -1,8 +1,6 @@ 443 | -The quick brown fox jumps over the lazy dog 444 | +The quick brown fox jumps over the lazy cat 445 | 446 | a 447 | -b 448 | c 449 | d 450 | -e 451 | f 452 | ``` 453 | 454 | ````md 455 | ```diff 456 | ## git diff a/test.txt b/test.txt 457 | diff --git a/a/test.txt b/b/test.txt 458 | index 309ee57..c995021 100644 459 | --- a/a/test.txt 460 | +++ b/b/test.txt 461 | @@ -1,8 +1,6 @@ 462 | -The quick brown fox jumps over the lazy dog 463 | +The quick brown fox jumps over the lazy cat 464 | 465 | a 466 | -b 467 | c 468 | d 469 | -e 470 | f 471 | ``` 472 | ```` 473 | 474 | ```diff 475 | - Text in Red 476 | + Text in Green 477 | ! Text in Orange 478 | # Text in Gray 479 | @@ Text in Purple and bold @@ 480 | ``` 481 | 482 | ````md 483 | ```diff 484 | - Text in Red 485 | + Text in Green 486 | ! Text in Orange 487 | # Text in Gray 488 | @@ Text in Purple and bold @@ 489 | ``` 490 | ```` 491 | 492 | # Alignments 493 | 494 | ```md 495 |

496 | 497 |

498 | ``` 499 | 500 |

501 | 502 | Vintage-style alarm clock with Roman numerals on its face, set on a surface covered with newspaper, with a blurred background. 503 |

504 | 505 | ```md 506 |

507 | 508 |

509 | ``` 510 | 511 |

512 | 513 | Vintage-style alarm clock with Roman numerals on its face, set on a surface covered with newspaper, with a blurred background. 514 |

515 | 516 | ```md 517 |

518 | 519 |

520 | ``` 521 | 522 |

523 | 524 | Vintage-style alarm clock with Roman numerals on its face, set on a surface covered with newspaper, with a blurred background. 525 |

526 | 527 | ```md 528 |

My latest Medium posts

529 | ``` 530 | 531 | 532 |

My latest Medium posts

533 | 534 | # Tables 535 | 536 | ```md 537 | 538 | 539 | 542 | 545 | 548 | 549 |
540 | The quick brown fox jumps over the lazy dog. 541 | 543 | The quick brown fox jumps over the lazy dog. 544 | 546 | The quick brown fox jumps over the lazy dog. 547 |
550 | ``` 551 | 552 | 553 | 554 | 557 | 560 | 563 | 564 |
555 | The quick brown fox jumps over the lazy dog. 556 | 558 | The quick brown fox jumps over the lazy dog. 559 | 561 | The quick brown fox jumps over the lazy dog. 562 |
565 | 566 | ```md 567 | | Default | Left align | Center align | Right align | 568 | | - | :- | :-: | -: | 569 | | 9999999999 | 9999999999 | 9999999999 | 9999999999 | 570 | | 999999999 | 999999999 | 999999999 | 999999999 | 571 | | 99999999 | 99999999 | 99999999 | 99999999 | 572 | | 9999999 | 9999999 | 9999999 | 9999999 | 573 | 574 | | Default | Left align | Center align | Right align | 575 | | ---------- | :--------- | :----------: | ----------: | 576 | | 9999999999 | 9999999999 | 9999999999 | 9999999999 | 577 | | 999999999 | 999999999 | 999999999 | 999999999 | 578 | | 99999999 | 99999999 | 99999999 | 99999999 | 579 | | 9999999 | 9999999 | 9999999 | 9999999 | 580 | 581 | Default | Left align | Center align | Right align 582 | ---------- | :--------- | :----------: | ----------: 583 | 9999999999 | 9999999999 | 9999999999 | 9999999999 584 | 999999999 | 999999999 | 999999999 | 999999999 585 | 99999999 | 99999999 | 99999999 | 99999999 586 | 9999999 | 9999999 | 9999999 | 9999999 587 | ``` 588 | 589 | | Default | Left align | Center align | Right align | 590 | | - | :- | :-: | -: | 591 | | 9999999999 | 9999999999 | 9999999999 | 9999999999 | 592 | | 999999999 | 999999999 | 999999999 | 999999999 | 593 | | 99999999 | 99999999 | 99999999 | 99999999 | 594 | | 9999999 | 9999999 | 9999999 | 9999999 | 595 | 596 | | Default | Left align | Center align | Right align | 597 | | ---------- | :--------- | :----------: | ----------: | 598 | | 9999999999 | 9999999999 | 9999999999 | 9999999999 | 599 | | 999999999 | 999999999 | 999999999 | 999999999 | 600 | | 99999999 | 99999999 | 99999999 | 99999999 | 601 | | 9999999 | 9999999 | 9999999 | 9999999 | 602 | 603 | 604 | Default | Left align | Center align | Right align 605 | ---------- | :--------- | :----------: | ----------: 606 | 9999999999 | 9999999999 | 9999999999 | 9999999999 607 | 999999999 | 999999999 | 999999999 | 999999999 608 | 99999999 | 99999999 | 99999999 | 99999999 609 | 9999999 | 9999999 | 9999999 | 9999999 610 | 611 | 612 | ```md 613 | 614 | 615 | 616 | 617 | 618 | 619 | 620 |
Heading 1Heading 2
621 | 622 | | A | B | C | 623 | |--|--|--| 624 | | 1 | 2 | 3 | 625 | 626 | 627 | 628 | | A | B | C | 629 | |--|--|--| 630 | | 1 | 2 | 3 | 631 | 632 |
633 | ``` 634 | 635 | 636 | 637 | 638 | 639 | 640 | 641 | 642 |
Heading 1Heading 2
643 | 644 | | A | B | C | 645 | |--|--|--| 646 | | 1 | 2 | 3 | 647 | 648 | 649 | 650 | | A | B | C | 651 | |--|--|--| 652 | | 1 | 2 | 3 | 653 | 654 |
655 | 656 | ```md 657 | | A | B | C | 658 | |---|---|---| 659 | | 1 | 2 | 3
4
5 | 660 | ``` 661 | 662 | | A | B | C | 663 | |---|---|---| 664 | | 1 | 2 | 3
4
5 | 665 | 666 | ```md 667 | 668 | 669 | 670 | 671 | 672 | 673 | 681 | 689 | 690 |
Before HoistingAfter Hoisting
674 | 
 675 | console.log(fullName); // undefined
 676 | fullName = "Dariana Trahan";
 677 | console.log(fullName); // Dariana Trahan
 678 | var fullName;
 679 |
680 | 		682 | 
 683 | var fullName;
 684 | console.log(fullName); // undefined
 685 | fullName = "Dariana Trahan";
 686 | console.log(fullName); // Dariana Trahan
 687 |
688 |
691 | ``` 692 | 693 | 694 | 695 | 696 | 697 | 698 | 699 | 707 | 715 | 716 |
Before HoistingAfter Hoisting
700 | 
 701 | console.log(fullName); // undefined
 702 | fullName = "Dariana Trahan";
 703 | console.log(fullName); // Dariana Trahan
 704 | var fullName;
 705 |
706 | 		708 | 
 709 | var fullName;
 710 | console.log(fullName); // undefined
 711 | fullName = "Dariana Trahan";
 712 | console.log(fullName); // Dariana Trahan
 713 |
714 |
717 | 718 | # Links 719 | 720 | ## Inline 721 | 722 | ```md 723 | [The-Ultimate-Markdown-Cheat-Sheet](https://github.com/lifeparticle/Markdown-Cheatsheet) 724 | ``` 725 | 726 | [The-Ultimate-Markdown-Cheat-Sheet](https://github.com/lifeparticle/The-Ultimate-Markdown-Cheat-Sheet) 727 | 728 | ## Reference 729 | 730 | ```md 731 | [The-Ultimate-Markdown-Cheat-Sheet][reference text] 732 | 733 | [The-Ultimate-Markdown-Cheat-Sheet][1] 734 | 735 | [Markdown-Cheat-Sheet] 736 | 737 | [reference text]: https://github.com/lifeparticle/Markdown-Cheatsheet 738 | [1]: https://github.com/lifeparticle/Markdown-Cheatsheet 739 | [Markdown-Cheat-Sheet]: https://github.com/lifeparticle/Markdown-Cheatsheet 740 | ``` 741 | 742 | [The-Ultimate-Markdown-Cheat-Sheet][reference text] 743 | 744 | [The-Ultimate-Markdown-Cheat-Sheet][1] 745 | 746 | [Markdown-Cheat-Sheet] 747 | 748 | [reference text]: https://github.com/lifeparticle/The-Ultimate-Markdown-Cheat-Sheet 749 | [1]: https://github.com/lifeparticle/The-Ultimate-Markdown-Cheat-Sheet 750 | [Markdown-Cheat-Sheet]: https://github.com/lifeparticle/The-Ultimate-Markdown-Cheat-Sheet 751 | 752 | ## Footnote 753 | 754 | Footnote.[^1] 755 | 756 | Some other important footnote.[^2] 757 | 758 | [^1]: This is footnote number one. 759 | [^2]: Here is the second footnote. 760 | 761 | ```md 762 | Footnote.[^1] 763 | 764 | Some other important footnote.[^2] 765 | 766 | [^1]: This is footnote number one. 767 | [^2]: Here is the second footnote. 768 | ``` 769 | 770 | Screen Shot 2024-02-06 at 8 23 52 pm 771 | 772 | ## Relative 773 | 774 | ```md 775 | [Example of a relative link](rl.md) 776 | ``` 777 | 778 | [Example of a relative link](rl.md) 779 | 780 | ## Auto 781 | 782 | ```md 783 | Visit https://github.com/ 784 | ``` 785 | 786 | Visit https://github.com/ 787 | 788 | ```md 789 | Email at example@example.com 790 | ``` 791 | 792 | Email at example@example.com 793 | 794 | ## Section 795 | 796 | Screen Shot 2024-02-04 at 12 49 07 pm 797 | 798 | ## Hover 799 | 800 | You can use [BinaryTree](https://binarytree.dev/ "Array of Developer Productivity Tools Designed to Help You Save Time") to create markdown tables. 801 | 802 | 803 | You can use [BinaryTree](## "Array of Developer Productivity Tools Designed to Help You Save Time") to create markdown tables. 804 | 805 | ## Enclosed 806 | 807 | ```md 808 | 809 | ``` 810 | 811 | 812 | 813 | ## Highlight words and link it to a URL 814 | 815 | ```md 816 | [BinaryTree](https://binarytree.dev/) 817 | ``` 818 | 819 | [BinaryTree](https://binarytree.dev/) 820 | 821 | ![Jun-15-2024 09-55-51](https://github.com/lifeparticle/Markdown-Cheatsheet/assets/1612112/68d9c7a9-6b05-472f-bbc6-c1e180674502) 822 | 823 | # Images 824 | 825 | Alt text and title are optional. 826 | 827 | ```md 828 | ![alt text](https://images.unsplash.com/photo-1415604934674-561df9abf539?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=100&q=80 "Title text") 829 | ``` 830 | 831 | ![alt text](https://images.unsplash.com/photo-1415604934674-561df9abf539?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=100&q=80) 832 | 833 | ```md 834 | ![alt text][image] 835 | 836 | [image]: https://images.unsplash.com/photo-1415604934674-561df9abf539?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=100&q=80 "Title text" 837 | ``` 838 | 839 | ![alt text][image] 840 | 841 | [image]: https://images.unsplash.com/photo-1415604934674-561df9abf539?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=100&q=80 "Title text" 842 | 843 | ```md 844 | 845 | ``` 846 | 847 | 848 | alt text 849 | 850 | GIF of students in a grand hall joyfully throwing their graduation caps into the air in celebration, with large banners and lit torches decorating the background. 851 | 852 | ```md 853 | 854 | ``` 855 | 856 | Green button with the text 'theultimatemarkdowncheatsheet' in white letters. 857 | 858 | ```md 859 | 860 | ``` 861 | 862 | Animated SVG of the text 'Markdown-Cheatsheet' in white letters. 863 | 864 | ```md 865 | Animated SVG of the text 'Markdown-Cheatsheet' in white letters. 866 | ``` 867 | 868 | [![BinaryTree](https://github.com/lifeparticle/lifeparticle/blob/master/gh_social_light.png)](https://binarytree.dev/) 869 | 870 | ```md 871 | [![BinaryTree](https://github.com/lifeparticle/lifeparticle/blob/master/gh_social_light.png)](https://binarytree.dev/) 872 | ``` 873 | 874 | 875 | Logo of BinaryTree featuring a hexagonal icon and the text 'BINARY TREE' in capital letters to the right of the icon. 876 | 877 | ```md 878 | 879 | ``` 880 | 881 | ## Theme 882 | 883 | ### Using picture tag 884 | 885 | The HTML `` element, along with the `prefers-color-scheme` media feature, enables you to dynamically adjust images according to the user's color scheme preference, providing options for both light and dark modes. 886 | 887 | For example, the code snippet below demonstrates how to display a dark-themed BinaryTree logo when the user's device is set to a dark mode, and a light-themed BinaryTree logo for light mode settings: 888 | 889 | ```md 890 | 891 | 892 | 893 | BinaryTree 894 | 895 | ``` 896 | 897 | 898 | 899 | 900 | BinaryTree 901 | 902 | 903 | ### Using dark and light mode 904 | 905 | ```md 906 | [![Badge][Logo-dark]](https://binarytree.dev#gh-dark-mode-only) 907 | [![Badge][Logo-light]](https://binarytree.dev#gh-light-mode-only) 908 | 909 | [Logo-dark]: https://github-readme-stats.vercel.app/api?username=lifeparticle&theme=graywhite&show_icons=true#gh-light-mode-only 910 | [Logo-light]: https://github-readme-stats.vercel.app/api?username=lifeparticle&theme=dark&show_icons=true#gh-dark-mode-only 911 | ``` 912 | 913 | [![Badge][Logo-dark]](https://binarytree.dev#gh-dark-mode-only) 914 | [![Badge][Logo-light]](https://binarytree.dev#gh-light-mode-only) 915 | 916 | [Logo-light]: https://github-readme-stats.vercel.app/api?username=lifeparticle&theme=graywhite&show_icons=true#gh-light-mode-only 917 | [Logo-dark]: https://github-readme-stats.vercel.app/api?username=lifeparticle&theme=dark&show_icons=true#gh-dark-mode-only 918 | 919 | ```md 920 | 921 | This image shows a summary of Mahbub Zaman's GitHub statistics. 922 | 923 | 924 | This image shows a summary of Mahbub Zaman's GitHub statistics. 925 | 926 | ``` 927 | 928 | 929 | This image shows a summary of Mahbub Zaman's GitHub statistics. 930 | 931 | 932 | This image shows a summary of Mahbub Zaman's GitHub statistics. 933 | 934 | 935 | ## Group 936 | 937 | Horizontal images 938 | 939 |

940 | alt text 941 | alt text 942 | alt text 943 |

944 | 945 | ```md 946 |

947 | alt text 948 | alt text 949 | alt text 950 |

951 | ``` 952 | 953 | Horizontal images with gap 954 | 955 |

956 | alt text 957 | alt text 958 | alt text 959 |

960 | 961 | ```md 962 |

963 | alt text 964 | alt text 965 | alt text 966 |

967 | ``` 968 | 969 | Vertical images 970 | 971 |

972 | alt text 973 |
974 | alt text 975 |
976 | alt text 977 |

978 | 979 | ```md 980 |

981 | alt text 982 |
983 | alt text 984 |
985 | alt text 986 |

987 | ``` 988 | 989 | Vertical images with gap 990 | 991 |

992 | alt text 993 |

994 | alt text 995 |

996 | alt text 997 |

998 | 999 | ```md 1000 |

1001 | alt text 1002 |

1003 | alt text 1004 |

1005 | alt text 1006 |

1007 | ``` 1008 | 1009 | # Badges 1010 | 1011 | ```md 1012 | ![GitHub forks](https://img.shields.io/github/forks/lifeparticle/Markdown-Cheatsheet?style=for-the-badge) 1013 | ``` 1014 | 1015 | ![GitHub forks](https://img.shields.io/github/forks/lifeparticle/Markdown-Cheatsheet?style=for-the-badge) 1016 | 1017 | # Videos 1018 | 1019 | To embed a video in Markdown, you need to first upload the video file and then reference it inline: 1020 | 1021 | https://github.com/user-attachments/assets/90c624e0-f46b-47a7-8509-97585dc3688a 1022 | 1023 | ```md 1024 | https://github.com/user-attachments/assets/90c624e0-f46b-47a7-8509-97585dc3688a 1025 | ``` 1026 | 1027 | # Lists 1028 | 1029 | ## Ordered 1030 | 1031 | Mac: command+shift+7 1032 | 1033 | Windows: control+shift+7 1034 | 1035 | ```md 1036 | 1. One 1037 | 2. Two 1038 | 3. Three 1039 | ``` 1040 | 1041 | 1. One 1042 | 2. Two 1043 | 3. Three 1044 | 1045 | ```md 1046 | 1. First level 1047 | 1. Second level 1048 | - Third level 1049 | - Fourth level 1050 | 2. First level 1051 | 1. Second level 1052 | 3. First level 1053 | 1. Second level 1054 | ``` 1055 | 1056 | 1. First level 1057 | 1. Second level 1058 | - Third level 1059 | - Fourth level 1060 | 2. First level 1061 | 1. Second level 1062 | 3. First level 1063 | 1. Second level 1064 | 1065 | ## Unordered 1066 | 1067 | Mac: command+shift+8 1068 | 1069 | Windows: control+shift+8 1070 | 1071 | ```md 1072 | * 1 1073 | * 2 1074 | * 3 1075 | 1076 | + 1 1077 | + 2 1078 | + 3 1079 | 1080 | 1081 | - 1 1082 | - 2 1083 | - 3 1084 | ``` 1085 | 1086 | 1087 | 1088 | * 1 1089 | * 2 1090 | * 3 1091 | 1092 | + 1 1093 | + 2 1094 | + 3 1095 | 1096 | 1097 | 1098 | - 1 1099 | - 2 1100 | - 3 1101 | 1102 | ```md 1103 | - First level 1104 | - Second level 1105 | - Third level 1106 | - Fourth level 1107 | - First level 1108 | - Second level 1109 | - First level 1110 | - Second level 1111 | ``` 1112 | 1113 | - First level 1114 | - Second level 1115 | - Third level 1116 | - Fourth level 1117 | - First level 1118 | - Second level 1119 | - First level 1120 | - Second level 1121 | 1122 | ```md 1123 |
    1124 |
  • First item
    • 1125 |
  • Second item
    • 1126 |
  • Third item
    • 1127 |
  • Fourth item
    • 1128 |
1129 | ``` 1130 | 1131 |
    1132 |
  • First item
    • 1133 |
  • Second item
    • 1134 |
  • Third item
    • 1135 |
  • Fourth item
    • 1136 |
1137 | 1138 | ## Task 1139 | 1140 | ```md 1141 | - [x] Fix Bug 223 1142 | - [ ] Add Feature 33 1143 | - [ ] Add unit tests 1144 | ``` 1145 | 1146 | - [x] Fix Bug 223 1147 | - [ ] Add Feature 33 1148 | - [ ] Add unit tests 1149 | 1150 | # Buttons 1151 | 1152 | ```md 1153 | cmd + shift + p 1154 | ``` 1155 | 1156 | cmd + shift + p 1157 | 1158 | ```md 1159 |  
 cmd + shift + p 
  1160 | ``` 1161 | 1162 |  
 cmd + shift + p 
  1163 | 1164 | ```md 1165 | [Markdown-Cheatsheet](https://github.com/lifeparticle/Markdown-Cheatsheet) 1166 | ``` 1167 | 1168 | [Markdown-Cheatsheet](https://github.com/lifeparticle/Markdown-Cheatsheet) 1169 | 1170 | ```md 1171 | [Markdown-Cheatsheet](https://github.com/lifeparticle/Markdown-Cheatsheet) 1172 | ``` 1173 | 1174 | [Markdown-Cheatsheet](https://github.com/lifeparticle/Markdown-Cheatsheet) 1175 | 1176 | ## Button with emoji 1177 | 1178 | 1179 |  
[Markdown-Cheatsheet](https://github.com/lifeparticle/Markdown-Cheatsheet) ↗️
  1180 | 1181 | ```md 1182 |  
[Markdown-Cheatsheet](https://github.com/lifeparticle/Markdown-Cheatsheet) ↗️
  1183 | ``` 1184 | 1185 | # Collapsible items (28 July 2023) 1186 | 1187 | ```md 1188 |
1189 | Markdown 1190 | 1191 | - [Markdown Editor](https://binarytree.dev/me) 1192 | - [Table Of Content](https://binarytree.dev/toc) 1193 | - [Markdown Table Generator](https://binarytree.dev/md_table_generator) 1194 | 1195 |
1196 | ``` 1197 | 1198 |
1199 | Markdown 1200 | 1201 | - [Markdown Editor](https://binarytree.dev/me) 1202 | - [Table Of Content](https://binarytree.dev/toc) 1203 | - [Markdown Table Generator](https://binarytree.dev/md_table_generator) 1204 | 1205 |
1206 | 1207 | # Horizontal Rule 1208 | 1209 | ```md 1210 | --- 1211 | *** 1212 | ___ 1213 | ``` 1214 | 1215 | --- 1216 | 1217 | 1218 | *** 1219 | 1220 | 1221 | ___ 1222 | 1223 | # Diagrams (19 July 2022) 1224 | 1225 | ````md 1226 | ```mermaid 1227 | pie 1228 | "Movies" : 80 1229 | "TV shows" : 20 1230 | ``` 1231 | ```` 1232 | 1233 | ```mermaid 1234 | pie 1235 | "Movies" : 80 1236 | "TV shows" : 20 1237 | ``` 1238 | 1239 | # Mathematical expressions (19 July 2022) 1240 | 1241 | > [!IMPORTANT] 1242 | > Check out the official documentation on [GitHub](https://docs.github.com/en/get-started/writing-on-github/working-with-advanced-formatting/writing-mathematical-expressions) to learn more about writing and formatting MathJax syntax. 1243 | 1244 | ```md 1245 | This is an inline math expression $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$ 1246 | ``` 1247 | 1248 | This is an inline math expression $x = {-b \pm \sqrt{b^2-4ac} \over 2a}$ 1249 | 1250 | ```md 1251 | $$ 1252 | x = {-b \pm \sqrt{b^2-4ac} \over 2a} 1253 | $$ 1254 | ``` 1255 | 1256 | $$ 1257 | x = {-b \pm \sqrt{b^2-4ac} \over 2a} 1258 | $$ 1259 | 1260 | # Alerts (8 January 2024) 1261 | 1262 | ```md 1263 | > [!NOTE] 1264 | > Essential details that users should not overlook, even when browsing quickly. 1265 | 1266 |
1267 | 1268 | > [!TIP] 1269 | > Additional advice to aid users in achieving better outcomes. 1270 | 1271 |
1272 | 1273 | > [!IMPORTANT] 1274 | > Vital information required for users to attain success. 1275 | 1276 |
1277 | 1278 | > [!WARNING] 1279 | > Urgent content that requires immediate user focus due to possible risks. 1280 | 1281 |
1282 | 1283 | > [!CAUTION] 1284 | > Possible negative outcomes resulting from an action. 1285 | ``` 1286 | 1287 | > [!NOTE] 1288 | > Essential details that users should not overlook, even when browsing quickly. 1289 | 1290 |
1291 | 1292 | > [!TIP] 1293 | > Additional advice to aid users in achieving better outcomes. 1294 | 1295 |
1296 | 1297 | > [!IMPORTANT] 1298 | > Vital information required for users to attain success. 1299 | 1300 |
1301 | 1302 | > [!WARNING] 1303 | > Urgent content that requires immediate user focus due to possible risks. 1304 | 1305 |
1306 | 1307 | > [!CAUTION] 1308 | > Possible negative outcomes resulting from an action. 1309 | 1310 | # Mention people and teams 1311 | 1312 | In issues: 1313 | 1314 | ```md 1315 | @lifeparticle 1316 | ``` 1317 | 1318 | [Example shown in issue](https://github.com/lifeparticle/Markdown-Cheatsheet/issues/1) 1319 | 1320 | In markdown file: 1321 | 1322 | ```md 1323 | https://github.com/lifeparticle 1324 | ``` 1325 | 1326 | https://github.com/lifeparticle 1327 | 1328 | # Reference issues and pull requests 1329 | 1330 | In issues: 1331 | 1332 | ```md 1333 | #1 1334 | #10 1335 | ``` 1336 | 1337 | [Example shown in issue](https://github.com/lifeparticle/Markdown-Cheatsheet/issues/1) 1338 | 1339 | In markdown file: 1340 | 1341 | ```md 1342 | https://github.com/lifeparticle/Markdown-Cheatsheet/issues/1 1343 | https://github.com/lifeparticle/Markdown-Cheatsheet/pull/10 1344 | ``` 1345 | 1346 | https://github.com/lifeparticle/Markdown-Cheatsheet/issues/1 1347 | 1348 | https://github.com/lifeparticle/Markdown-Cheatsheet/pull/10 1349 | 1350 | # Color models 1351 | 1352 | In issues: 1353 | 1354 | ```md 1355 | `#ffffff` 1356 | `#000000` 1357 | ``` 1358 | 1359 | [Example shown in issue](https://github.com/lifeparticle/Markdown-Cheatsheet/issues/1) 1360 | 1361 | ![image](https://github.com/user-attachments/assets/523128b8-e877-4e6f-884c-28691eaa1d8f) 1362 | 1363 | # View Code 1364 | 1365 | Click either the Code (top right) or Raw (top left) option to see the markdown code. 1366 | 1367 | code 1368 | 1369 | > [!NOTE] 1370 | > Make sure you have clicked the markdown file to see the above view. 1371 | 1372 | file 1373 | 1374 | # Code in titles 1375 | 1376 | In issue, and pull request titles. 1377 | 1378 | `TEST` ISSUE 1379 | 1380 | ```md 1381 | 1382 | `TEST` ISSUE 1383 | 1384 | ``` 1385 | 1386 | Screen Shot 2024-06-05 at 12 11 37 pm 1387 | 1388 | # Reference Labels 1389 | 1390 | Labels referenced by URLs in Markdown are now automatically rendered. 1391 | 1392 | https://github.com/lifeparticle/Markdown-Cheatsheet/labels/documentation 1393 | 1394 | ```md 1395 | https://github.com/lifeparticle/Markdown-Cheatsheet/labels/documentation 1396 | ``` 1397 | 1398 | # Miscellaneous 1399 | 1400 | ## Comments 1401 | 1402 | 1405 | 1406 | ```md 1407 | 1410 | ``` 1411 | 1412 | ## Escaping Markdown Characters 1413 | 1414 | - **Before escaping** 1415 | 1416 | ```md 1417 | * Asterisk 1418 | \ Backslash 1419 | ` Backtick 1420 | {} Curly braces 1421 | . Dot 1422 | ! Exclamation mark 1423 | # Hash symbol 1424 | 1425 | - Hyphen symbol 1426 | 1427 | () Parentheses 1428 | 1429 | + Plus symbol 1430 | 1431 | [] Square brackets 1432 | _ Underscore` 1433 | ``` 1434 | 1435 | * Asterisk 1436 | \ Backslash 1437 | ` Backtick 1438 | {} Curly braces 1439 | . Dot 1440 | ! Exclamation mark 1441 | 1442 | # Hash symbol 1443 | 1444 | - Hyphen symbol 1445 | 1446 | () Parentheses 1447 | 1448 | + Plus symbol 1449 | 1450 | [] Square brackets 1451 | _ Underscore 1452 | 1453 | - **After escaping** 1454 | 1455 | ```md 1456 | \* Asterisk 1457 | \\ Backslash 1458 | \` Backtick 1459 | \{} Curly braces 1460 | \. Dot 1461 | \! Exclamation mark 1462 | \# Hash symbol 1463 | \- Hyphen symbol 1464 | \() Parentheses 1465 | \+ Plus symbol 1466 | \[] Square brackets 1467 | \_ Underscore 1468 | ``` 1469 | 1470 | \* Asterisk 1471 | \\ Backslash 1472 | \` Backtick 1473 | \{} Curly braces 1474 | \. Dot 1475 | \! Exclamation mark 1476 | \# Hash symbol 1477 | \- Hyphen symbol 1478 | \() Parentheses 1479 | \+ Plus symbol 1480 | \[] Square brackets 1481 | \_ Underscore 1482 | 1483 | ## Emojis 1484 | 1485 | ```md 1486 | :octocat: 1487 | ``` 1488 | 1489 | :octocat: 1490 | 1491 | [Complete list of github markdown emoji markup](https://gist.github.com/rxaviers/7360908) 1492 | 1493 | ## Line break 1494 | 1495 | 1496 | You can use `
` to insert a single line break. Make sure to use an em space ` `. For example: 1497 | 1498 | ```md 1499 |
 
 The quick brown fox jumps over the lazy dog. 
 
1500 | ``` 1501 | 1502 |
 
 The 1503 | quick brown fox jumps over the lazy 1504 | dog. 
 
1505 | 1506 | Or 1507 | 1508 | ```md 1509 |
 


 The quick brown fox jumps over the lazy dog. 


 
1510 | ``` 1511 | 1512 |
 


 The 1513 | quick brown fox jumps over the lazy 1514 | dog. 


 
1515 | 1516 | ## Back to top 1517 | 1518 | First place the following code at start of your markdown file 1519 | 1520 | ```md 1521 | 1522 | ``` 1523 | 1524 | Then use one of the following code at the place you want to return to top. 1525 | 1526 | [Back to top](#top) 1527 | 1528 | [:arrow_up:](#top) 1529 | 1530 | ```md 1531 | [Back to top](#top) 1532 | 1533 | [:arrow_up:](#top) 1534 | ``` 1535 | 1536 | # Bitbucket 1537 | 1538 | Bitbucket Supported Markdown for [READMEs](https://confluence.atlassian.com/bitbucketserver/markdown-syntax-guide-776639995.html). Also, create a [table of contents](https://support.atlassian.com/bitbucket-cloud/docs/add-a-table-of-contents-to-a-wiki/). 1539 | 1540 | # Azure DevOps Project wiki 1541 | 1542 | Azure DevOps Supported Markdown for [Project wiki](https://learn.microsoft.com/en-us/azure/devops/project/wiki/markdown-guidance?view=azure-devops). 1543 | 1544 | # MDX 1545 | 1546 | You can write JSX in your markdown document using [MDX](https://mdxjs.com/). 1547 | 1548 | # Tools 1549 | 1550 | 1. Create a Markdown table of content - [binarytree](https://binarytree.dev/markdown/toc), [github-markdown-toc](https://github.com/ekalinin/github-markdown-toc) 1551 | 2. Create an empty Markdown table - [Tablesgenerator](https://www.tablesgenerator.com/markdown_tables) 1552 | 3. Convert Excel to Markdown table - [Tableconvert](https://tableconvert.com/) 1553 | 4. Markdown preview for Sublime Text 3 - [Packagecontrol](https://packagecontrol.io/packages/MarkdownPreview) 1554 | 5. Markdown preview Visual Studio Code - [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced) 1555 | 6. A collection of awesome markdown goodies - [Awesome Markdown](https://github.com/mundimark/awesome-markdown) 1556 | 7. Markdownlint - [markdownlint](https://github.com/DavidAnson/markdownlint), [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2), [markdownlint-cli2-action](https://github.com/DavidAnson/markdownlint-cli2-action), [vscode-markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint) 1557 | 8. A lightweight Python utility for converting various files to Markdown - [Markitdown](https://github.com/microsoft/markitdown) 1558 | 9. A SSE MCP server for calling MarkItDown - [MarkItDown-MCP](https://github.com/microsoft/markitdown/tree/main/packages/markitdown-mcp) 1559 | 1560 | --- 1561 | 1562 |
1563 | 1564 | This README has been optimized for accessibility based on GitHub's blogpost 1565 | "[Tips for Making your GitHub Profile Page Accessible](https://github.blog/2023-10-26-5-tips-for-making-your-github-profile-page-accessible)". 1566 | 1567 |
1568 | --------------------------------------------------------------------------------