├── .github ├── FUNDING.yml ├── ISSUE_TEMPLATE │ ├── bug_report.md │ └── feature_request.md └── pull_request_template.md ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── LICENSE └── README.md /.github/FUNDING.yml: -------------------------------------------------------------------------------- 1 | # These are supported funding model platforms 2 | 3 | github: [atapas] 4 | -------------------------------------------------------------------------------- /.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 | 1. Go to '...' 16 | 2. Click on '....' 17 | 3. Scroll down to '....' 18 | 4. See error 19 | 20 | **Expected behavior** 21 | A clear and concise description of what you expected to happen. 22 | 23 | **Screenshots** 24 | If applicable, add screenshots to help explain your problem. 25 | 26 | **Desktop (please complete the following information):** 27 | - OS: [e.g. iOS] 28 | - Browser [e.g. chrome, safari] 29 | - Version [e.g. 22] 30 | 31 | **Smartphone (please complete the following information):** 32 | - Device: [e.g. iPhone6] 33 | - OS: [e.g. iOS8.1] 34 | - Browser [e.g. stock browser, safari] 35 | - Version [e.g. 22] 36 | 37 | **Additional context** 38 | Add any other context about the problem here. 39 | -------------------------------------------------------------------------------- /.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 frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/pull_request_template.md: -------------------------------------------------------------------------------- 1 | # Description 2 | 3 | Include a summary of what type of changes were made or which issues were fixed 4 | 5 | Fixes # (issue) 6 | 7 | ## Type of change 8 | 9 | Please delete options that are not relevant. 10 | 11 | - [ ] This change requires a documentation update 12 | 13 | # Checklist: 14 | 15 | - [ ] I have performed a self-review of my changes 16 | - [ ] I have made corresponding changes to the documentation 17 | - [ ] My changes generate no new warnings 18 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | We as members, contributors, and leaders pledge to make participation in our 6 | community a harassment-free experience for everyone, regardless of age, body 7 | size, visible or invisible disability, ethnicity, sex characteristics, gender 8 | identity and expression, level of experience, education, socio-economic status, 9 | nationality, personal appearance, race, religion, or sexual identity 10 | and orientation. 11 | 12 | We pledge to act and interact in ways that contribute to an open, welcoming, 13 | diverse, inclusive, and healthy community. 14 | 15 | ## Our Standards 16 | 17 | Examples of behavior that contributes to a positive environment for our 18 | community include: 19 | 20 | * Demonstrating empathy and kindness toward other people 21 | * Being respectful of differing opinions, viewpoints, and experiences 22 | * Giving and gracefully accepting constructive feedback 23 | * Accepting responsibility and apologizing to those affected by our mistakes, 24 | and learning from the experience 25 | * Focusing on what is best not just for us as individuals, but for the 26 | overall community 27 | 28 | Examples of unacceptable behavior include: 29 | 30 | * The use of sexualized language or imagery, and sexual attention or 31 | advances of any kind 32 | * Trolling, insulting or derogatory comments, and personal or political attacks 33 | * Public or private harassment 34 | * Publishing others' private information, such as a physical or email 35 | address, without their explicit permission 36 | * Other conduct which could reasonably be considered inappropriate in a 37 | professional setting 38 | 39 | ## Enforcement Responsibilities 40 | 41 | Community leaders are responsible for clarifying and enforcing our standards of 42 | acceptable behavior and will take appropriate and fair corrective action in 43 | response to any behavior that they deem inappropriate, threatening, offensive, 44 | or harmful. 45 | 46 | Community leaders have the right and responsibility to remove, edit, or reject 47 | comments, commits, code, wiki edits, issues, and other contributions that are 48 | not aligned to this Code of Conduct, and will communicate reasons for moderation 49 | decisions when appropriate. 50 | 51 | ## Scope 52 | 53 | This Code of Conduct applies within all community spaces, and also applies when 54 | an individual is officially representing the community in public spaces. 55 | Examples of representing our community include using an official e-mail address, 56 | posting via an official social media account, or acting as an appointed 57 | representative at an online or offline event. 58 | 59 | ## Enforcement 60 | 61 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 62 | reported to the community leaders responsible for enforcement at 63 | tapas.adhikary@gmail.com. 64 | All complaints will be reviewed and investigated promptly and fairly. 65 | 66 | All community leaders are obligated to respect the privacy and security of the 67 | reporter of any incident. 68 | 69 | ## Enforcement Guidelines 70 | 71 | Community leaders will follow these Community Impact Guidelines in determining 72 | the consequences for any action they deem in violation of this Code of Conduct: 73 | 74 | ### 1. Correction 75 | 76 | **Community Impact**: Use of inappropriate language or other behavior deemed 77 | unprofessional or unwelcome in the community. 78 | 79 | **Consequence**: A private, written warning from community leaders, providing 80 | clarity around the nature of the violation and an explanation of why the 81 | behavior was inappropriate. A public apology may be requested. 82 | 83 | ### 2. Warning 84 | 85 | **Community Impact**: A violation through a single incident or series 86 | of actions. 87 | 88 | **Consequence**: A warning with consequences for continued behavior. No 89 | interaction with the people involved, including unsolicited interaction with 90 | those enforcing the Code of Conduct, for a specified period of time. This 91 | includes avoiding interactions in community spaces as well as external channels 92 | like social media. Violating these terms may lead to a temporary or 93 | permanent ban. 94 | 95 | ### 3. Temporary Ban 96 | 97 | **Community Impact**: A serious violation of community standards, including 98 | sustained inappropriate behavior. 99 | 100 | **Consequence**: A temporary ban from any sort of interaction or public 101 | communication with the community for a specified period of time. No public or 102 | private interaction with the people involved, including unsolicited interaction 103 | with those enforcing the Code of Conduct, is allowed during this period. 104 | Violating these terms may lead to a permanent ban. 105 | 106 | ### 4. Permanent Ban 107 | 108 | **Community Impact**: Demonstrating a pattern of violation of community 109 | standards, including sustained inappropriate behavior, harassment of an 110 | individual, or aggression toward or disparagement of classes of individuals. 111 | 112 | **Consequence**: A permanent ban from any sort of public interaction within 113 | the community. 114 | 115 | ## Attribution 116 | 117 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], 118 | version 2.0, available at 119 | https://www.contributor-covenant.org/version/2/0/code_of_conduct.html. 120 | 121 | Community Impact Guidelines were inspired by [Mozilla's code of conduct 122 | enforcement ladder](https://github.com/mozilla/diversity). 123 | 124 | [homepage]: https://www.contributor-covenant.org 125 | 126 | For answers to common questions about this code of conduct, see the FAQ at 127 | https://www.contributor-covenant.org/faq. Translations are available at 128 | https://www.contributor-covenant.org/translations. 129 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing 2 | 3 | When contributing to this repository, please first discuss the change you wish to make via issue, 4 | email, or any other method with the owners of this repository before making a change. 5 | 6 | Please note we have a code of conduct, please follow it in all your interactions with the project. 7 | 8 | ## Pull Request Process 9 | 10 | 1. Ensure any install or build dependencies are removed before the end of the layer when doing a 11 | build. 12 | 2. Update the README.md with details of changes to the interface, this includes new environment 13 | variables, exposed ports, useful file locations and container parameters. 14 | 3. Increase the version numbers in any examples files and the README.md to the new version that this 15 | Pull Request would represent. The versioning scheme we use is [SemVer](http://semver.org/). 16 | 4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you 17 | do not have permission to do that, you may request the second reviewer to merge it for you. 18 | 19 | ## Code of Conduct 20 | 21 | ### Our Pledge 22 | 23 | In the interest of fostering an open and welcoming environment, we as 24 | contributors and maintainers pledge to making participation in our project and 25 | our community a harassment-free experience for everyone, regardless of age, body 26 | size, disability, ethnicity, gender identity and expression, level of experience, 27 | nationality, personal appearance, race, religion, or sexual identity and 28 | orientation. 29 | 30 | ### Our Standards 31 | 32 | Examples of behavior that contributes to creating a positive environment 33 | include: 34 | 35 | * Using welcoming and inclusive language 36 | * Being respectful of differing viewpoints and experiences 37 | * Gracefully accepting constructive criticism 38 | * Focusing on what is best for the community 39 | * Showing empathy towards other community members 40 | 41 | Examples of unacceptable behavior by participants include: 42 | 43 | * The use of sexualized language or imagery and unwelcome sexual attention or 44 | advances 45 | * Trolling, insulting/derogatory comments, and personal or political attacks 46 | * Public or private harassment 47 | * Publishing others' private information, such as a physical or electronic 48 | address, without explicit permission 49 | * Other conduct which could reasonably be considered inappropriate in a 50 | professional setting 51 | 52 | ### Our Responsibilities 53 | 54 | Project maintainers are responsible for clarifying the standards of acceptable 55 | behavior and are expected to take appropriate and fair corrective action in 56 | response to any instances of unacceptable behavior. 57 | 58 | Project maintainers have the right and responsibility to remove, edit, or 59 | reject comments, commits, code, wiki edits, issues, and other contributions 60 | that are not aligned to this Code of Conduct, or to ban temporarily or 61 | permanently any contributor for other behaviors that they deem inappropriate, 62 | threatening, offensive, or harmful. 63 | 64 | ### Scope 65 | 66 | This Code of Conduct applies both within project spaces and in public spaces 67 | when an individual is representing the project or its community. Examples of 68 | representing a project or community include using an official project e-mail 69 | address, posting via an official social media account, or acting as an appointed 70 | representative at an online or offline event. Representation of a project may be 71 | further defined and clarified by project maintainers. 72 | 73 | ### Enforcement 74 | 75 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 76 | reported by contacting the project team at [tapas.adhikary@gmail.com](tapas.adhikary@gmail.com). All 77 | complaints will be reviewed and investigated and will result in a response that 78 | is deemed necessary and appropriate to the circumstances. The project team is 79 | obligated to maintain confidentiality with regard to the reporter of an incident. 80 | Further details of specific enforcement policies may be posted separately. 81 | 82 | Project maintainers who do not follow or enforce the Code of Conduct in good 83 | faith may face temporary or permanent repercussions as determined by other 84 | members of the project's leadership. 85 | 86 | ### Attribution 87 | 88 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 89 | available at [http://contributor-covenant.org/version/1/4][version] 90 | 91 | [homepage]: http://contributor-covenant.org 92 | [version]: http://contributor-covenant.org/version/1/4/ 93 | -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2022 Tapas Adhikary 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 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | 2 | # Table of Contents 3 | ` markdown-cheatsheet` is a single place for all the markdown syntaxes I have learned so far. Sharing publicly so that you also know about them and use. 4 | 5 | 1. [Headings](#headings) 6 | 2. [Code](#code) 7 | 3. [Unordered List of Items](#unordered-list-of-items) 8 | 4. [Ordered List of Items](#ordered-list-of-items) 9 | 5. [CheckBox Task List](#checkbox-task-list) 10 | 6. [Code Block](#code-block) 11 | 7. [Strikethrough Text](#strikethrough-text) 12 | 8. [Blockquote Text](#blockquote-text) 13 | 9. [Bold](#bold) 14 | 10. [Italic](#italic) 15 | 11. [Bold and Italic](#bold-and-italic) 16 | 12. [Link](#link) 17 | 13. [Image](#image) 18 | 14. [Linking an Image](#linking-an-image) 19 | 15. [Emojis](#emojis) 20 | 16. [Alerts](#alerts) 21 | 17. [Table](#table) 22 | 18. [Table With Alignments](#table-with-alignments) 23 | 19. [Horizontal Line](#horizontal-line) 24 | 20. [HTML](#html) 25 | 21. [Embed YouTube Video](#embed-youtube-video) 26 | 22. [Mathematical Expressions](#mathematical-expressions) 27 | 23. [DropDown](#dropdown) 28 | 24. [Diagrams](#diagrams) 29 | 25. [FootNote](#footnote) 30 | 26. [Comments](#comments) 31 | 32 | Many Thanks to all the `Stargazers` who has supported this project with stars(⭐) 33 | 34 | [](https://github.com/atapas/markdown-cheatsheet/stargazers) 35 | 36 | ## Headings 37 | 38 | **Syntax:** 39 | 40 | ``` 41 | # H1 - Heading 1 42 | ## H2 - Heading 2 43 | ### H3 - Heading 3 44 | #### H4 - Heading 4 45 | ##### H5 - Heading 5 46 | ###### H6 - Heading 6 47 | ``` 48 | **Output:** 49 | 50 | # H1 - Heading 1 51 | ## H2 - Heading 2 52 | ### H3 - Heading 3 53 | #### H4 - Heading 4 54 | ##### H5 - Heading 5 55 | ###### H6 - Heading 6 56 | 57 | ## Code 58 | 59 | **Syntax:** 60 | 61 | ``` 62 | `This is Code` 63 | ``` 64 | 65 | **Output:** 66 | 67 | `This is Code` 68 | 69 | ## Unordered List of Items 70 | 71 | **Syntax:** 72 | 73 | ``` 74 | - Milk 75 | - Tea 76 | - Beer 77 | ``` 78 | 79 | **Output:** 80 | 81 | - Milk 82 | - Tea 83 | - Beer 84 | 85 | **Syntax:** 86 | > This is an alternate syntax to create unordered list items. 87 | 88 | ``` 89 | * JavaScript 90 | * TypeScript 91 | * ReactJs 92 | ``` 93 | 94 | **Output:** 95 | 96 | * JavaScript 97 | * TypeScript 98 | * ReactJs 99 | 100 | ## Ordered List of Items 101 | 102 | **Syntax:** 103 | 104 | ``` 105 | 1. Eat 106 | 1. Walk 107 | 1. Sleep 108 | ``` 109 | 110 | **Output:** 111 | 112 | 1. Eat 113 | 1. Walk 114 | 1. Sleep 115 | 116 | ## CheckBox Task List 117 | 118 | **Syntax:** 119 | 120 | ``` 121 | - [X] Code 122 | - [ ] Review 123 | - [ ] Commit 124 | ``` 125 | 126 | **Output:** 127 | 128 | - [X] Code 129 | - [ ] Review 130 | - [ ] Commit 131 | 132 | ## Code Block 133 | 134 | **Syntax:** 135 | 136 | ```` 137 | ``` 138 | This is a code block. You can create for code syntaxes like JavaScript, HTML, CSS, Bash, and many more. 139 | ``` 140 | ```` 141 | 142 | **Output:** 143 | ``` 144 | This is a code block. You can create for code syntaxes like JavaScript, HTML, CSS, Bash, and many more. 145 | ``` 146 | 147 | In order to ***highlight the code***, you can add language name at the start of the backticks as in the following examples. 148 | 149 | **Example 1:** 150 | 151 | ```` 152 | ```js 153 | function print() { 154 | console.log('This is is a JavaScript Code Block'); 155 | } 156 | ``` 157 | ```` 158 | 159 | **Output:** 160 | ```js 161 | function print() { 162 | console.log('This is is a JavaScript Code Block'); 163 | } 164 | ``` 165 | 166 | **Example 2:** 167 | 168 | ```` 169 | ```bash 170 | # This is bash 171 | echo 1 172 | ``` 173 | ```` 174 | 175 | **Output:** 176 | ```bash 177 | # This is bash 178 | echo 1 179 | ``` 180 | 181 | ## Strikethrough Text 182 | 183 | **Syntax:** 184 | 185 | ``` 186 | ~~Sharing is NOT about Caring.~~ 187 | ``` 188 | 189 | **Output:** 190 | 191 | ~~Sharing is NOT about Caring.~~ 192 | 193 | ## Blockquote Text 194 | 195 | **Syntax:** 196 | 197 | ``` 198 | > When I say something, I mean it. When I mean it, I do it. When I do, I may fail. When I fail, I start talking about it again! 199 | ``` 200 | 201 | **Output:** 202 | 203 | > When I say something, I mean it. When I mean it, I do it. When I do, I may fail. When I fail, I start talking about it again! 204 | 205 | ## Bold 206 | 207 | **Syntax:** 208 | 209 | ``` 210 | **DO NOT UNDERESTIMATE THE POWER OF A PROGRAMMER.** 211 | ``` 212 | 213 | **Output:** 214 | 215 | **DO NOT UNDERESTIMATE THE POWER OF A PROGRAMMER.** 216 | 217 | ## Italic 218 | 219 | **Syntax:** 220 | 221 | ``` 222 | *It is Written in Italics* 223 | ``` 224 | 225 | **Output:** 226 | 227 | *It is Written in Italics* 228 | 229 | ## Bold and Italic 230 | 231 | **Syntax:** 232 | 233 | ``` 234 | ***You Can Combine Bold and Italics*** 235 | ``` 236 | 237 | **Output:** 238 | 239 | ***You Can Combine Bold and Italics*** 240 | 241 | ## Link 242 | 243 | **Syntax:** 244 | 245 | ``` 246 | Did you know I have [Website](https://tapasadhikary.com)? 247 | ``` 248 | 249 | **Output:** 250 | 251 | Did you know I have [Website](https://tapasadhikary.com)? 252 | 253 | ## Image 254 | 255 | **Syntax:** 256 | 257 | ``` 258 |  259 | ``` 260 | 261 | **Output:** 262 | 263 |  264 | 265 | ## Linking an Image 266 | 267 | **Syntax:** 268 | 269 | ``` 270 | [](hyperlink) 271 | ``` 272 | 273 | **Output:** 274 | 275 | [](https://blog.greenroots.info) 276 | 277 | ## Image Based on Theme 278 | 279 | **Syntax:** 280 | 281 | ``` 282 |  283 | ``` 284 | or 285 | ``` 286 |  287 | ``` 288 | 289 | **Output (try changing themes!):** 290 | 291 |  292 | 293 |  294 | 295 | 296 | ## Emojis 297 | 298 | **Syntax:** 299 | 300 | ``` 301 | :mango: :lemon: :man: :car: 302 | ``` 303 | 304 | **Output:** 305 | 306 | :mango: :lemon: :man: :car: 307 | 308 | ## Alerts 309 | 310 | **Syntax:** 311 | 312 | ```markdown 313 | > [!NOTE] 314 | > Git commits are snapshots of your code at a given time. 315 | ``` 316 | 317 | **Output:** 318 | 319 | > [!NOTE] 320 | > Git commits are snapshots of your code at a given time. 321 | 322 | **Syntax:** 323 | 324 | ```markdown 325 | > [!TIP] 326 | > Use `git status` often to stay aware of your changes. 327 | ``` 328 | 329 | **Output:** 330 | 331 | > [!TIP] 332 | > Use `git status` often to stay aware of your changes. 333 | 334 | **Syntax:** 335 | 336 | ```markdown 337 | > [!IMPORTANT] 338 | > Always commit your changes before switching branches to avoid losing work. 339 | ``` 340 | 341 | **Output:** 342 | 343 | > [!IMPORTANT] 344 | > Always commit your changes before switching branches to avoid losing work. 345 | 346 | **Syntax:** 347 | 348 | ```markdown 349 | 350 | > [!WARNING] 351 | > Don’t use `git push --force` unless you fully understand the consequences. 352 | ``` 353 | 354 | **Output:** 355 | 356 | > [!WARNING] 357 | > Don’t use `git push --force` unless you fully understand the consequences. 358 | 359 | **Syntax:** 360 | 361 | ```markdown 362 | > [!CAUTION] 363 | > Renaming branches in shared repositories can confuse collaborators. 364 | ``` 365 | 366 | **Output:** 367 | 368 | > [!CAUTION] 369 | > Renaming branches in shared repositories can confuse collaborators. 370 | 371 | ## Table 372 | 373 | **Syntax:** 374 | 375 | ``` 376 | | Fruit | Emoji | 377 | | ----------- | ----------- | 378 | | Mango | :mango: | 379 | | Lemon | :lemon: | 380 | ``` 381 | 382 | **Output:** 383 | 384 | 385 | | Fruit | Emoji | 386 | | ----------- | ----------- | 387 | | Mango | :mango: | 388 | | Lemon | :lemon: | 389 | 390 | ## Table With Alignments 391 | 392 | **Syntax:** 393 | 394 | ``` 395 | | Fruit(left) | Emoji(center) | Taste(right) | 396 | | :--- | :----: | ---: | 397 | | Mango is the king of Fruits | :mango: | Sweet and I love it | 398 | | Lemon is good for health | :lemon: | Sour, mix it in the water | 399 | ``` 400 | 401 | **Output:** 402 | 403 | | Fruit(left) | Emoji(center) | Taste(right) | 404 | | :--- | :----: | ---: | 405 | | Mango is the king of Fruits | :mango: | Sweet and I love it | 406 | | Lemon is good for health | :lemon: | Sour, mix it in the water | 407 | 408 | ## Horizontal Line 409 | 410 | **Syntax:** 411 | 412 | ``` 413 | --- 414 | ``` 415 | 416 | **Output:** 417 | 418 | --- 419 | 420 | ## HTML 421 | 422 | **Syntax:** 423 | 424 | ``` 425 |
426 | Yes, you can use allowed raw HTML in mark-down file. 427 | This is a paragraph aligned in the center. 428 |
429 | ``` 430 | 431 | **Output:** 432 | 433 |434 | Yes, you can use allowed raw HTML in mark-down file. 435 | This is a paragraph aligned in the center. 436 |
437 | 438 |