From e9fd9a6784f1164f3a900a510cccbcabb9bbcccd Mon Sep 17 00:00:00 2001 From: Aerial Robotics IIT KANPUR Date: Mon, 3 Jul 2023 09:53:56 +0000 Subject: [PATCH] GITBOOK-72: change request with no subject merged in GitBook --- SUMMARY.md | 1 + tutorials/cheatsheets/README.md | 4 + tutorials/cheatsheets/markdown-cheatsheet.md | 117 +++++++++++++++++++ 3 files changed, 122 insertions(+) create mode 100644 tutorials/cheatsheets/markdown-cheatsheet.md diff --git a/SUMMARY.md b/SUMMARY.md index d32265f..30b8a22 100644 --- a/SUMMARY.md +++ b/SUMMARY.md @@ -22,6 +22,7 @@ * [CMakeCheatsheet](tutorials/cheatsheets/cmake\_cheatsheet.md) * [GitCheatsheet](tutorials/cheatsheets/git\_cheatsheets.md) * [LatexCheatsheet](tutorials/cheatsheets/latex\_cheatsheet.md) + * [Markdown Cheatsheet](tutorials/cheatsheets/markdown-cheatsheet.md) * [Miscellaneous](tutorials/miscellaneous/README.md) * [Odroid XU4 Setup](tutorials/miscellaneous/odroid-xu4-setup.md) * [Simulation using Offboard Control](tutorials/miscellaneous/simulation-using-offboard-control/README.md) diff --git a/tutorials/cheatsheets/README.md b/tutorials/cheatsheets/README.md index 38d38a7..7c709ce 100644 --- a/tutorials/cheatsheets/README.md +++ b/tutorials/cheatsheets/README.md @@ -17,3 +17,7 @@ Pages in this section: {% content-ref url="latex_cheatsheet.md" %} [latex\_cheatsheet.md](latex\_cheatsheet.md) {% endcontent-ref %} + +{% content-ref url="markdown-cheatsheet.md" %} +[markdown-cheatsheet.md](markdown-cheatsheet.md) +{% endcontent-ref %} diff --git a/tutorials/cheatsheets/markdown-cheatsheet.md b/tutorials/cheatsheets/markdown-cheatsheet.md new file mode 100644 index 0000000..9cdb55a --- /dev/null +++ b/tutorials/cheatsheets/markdown-cheatsheet.md @@ -0,0 +1,117 @@ +# Markdown Cheatsheet + +````markdown +This Markdown cheat sheet provides a quick overview of all the Markdown syntax elements. It can’t cover every edge case, so if you need more information about any of these elements, refer to the reference guides for [basic syntax](https://www.markdownguide.org/basic-syntax) and [extended syntax](https://www.markdownguide.org/extended-syntax). + +## Basic Syntax + +These are the elements outlined in John Gruber’s original design document. All Markdown applications support these elements. + +### Heading + +# H1 +## H2 +### H3 + +### Bold + +**bold text** + +### Italic + +*italicized text* + +### Blockquote + +> blockquote + +### Ordered List + +1. First item +2. Second item +3. Third item + +### Unordered List + +- First item +- Second item +- Third item + +### Code + +`code` + +### Horizontal Rule + +--- + +### Link + +[Markdown Guide](https://www.youtube.com/watch?v=dQw4w9WgXcQ) + +### Image + +![alt text]("www.linkofthepng.com") + +## Extended Syntax + +These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements. + +### Table + +| Syntax | Description | +| ----------- | ----------- | +| Header | Title | +| Paragraph | Text | + +### Fenced Code Block + +``` +{ + "firstName": "John", + "lastName": "Smith", + "age": 25 +} +``` + +### Footnote + +Here's a sentence with a footnote. [^1] + +[^1]: This is the footnote. + +### Heading ID + +### My Great Heading {#custom-id} + +### Definition List + +term +: definition + +### Strikethrough + +~~The world is flat.~~ + +### Task List + +- [x] Write the press release +- [ ] Update the website +- [ ] Contact the media + +### Emoji + +That is so funny! :joy: + +### Highlight + +I need to highlight these ==very important words==. + +### Subscript + +H~2~O + +### Superscript + +X^2^ +````