Skip to content

Commit

Permalink
Create MarkdownHelp.md
Browse files Browse the repository at this point in the history
again very happy. all this is coming together. going to delete the html file as not needed anymore.
  • Loading branch information
skorpio07 authored May 6, 2024
1 parent 3fe6a37 commit 7f408be
Showing 1 changed file with 43 additions and 0 deletions.
43 changes: 43 additions & 0 deletions MarkdownHelp.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Overview

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 and extended syntax.

## Basic Syntax

These are the elements outlined in John Gruber's original design document. All Markdown applications support these elements.

Element | Markdown Syntax
--- | ---
Heading | `# H1`<br>`## H2`<br>`### H3`
Bold | `**bold text**`
Italic | `*italicized text*`
Blockquote | `> blockquote`
Ordered List | `1. First item`<br>`2. Second item`<br>`3. Third item`
Unordered List | `- First item`<br>`- Second item`<br>`- Third item`
Code | `` `code` ``
Horizontal Rule | `---`
Link | `title`
Image | `!alt text`

## Extended Syntax

These elements extend the basic syntax by adding additional features. Not all Markdown applications support these elements.

Element | Markdown Syntax
--- | ---
Table | `| Syntax | Description |`<br>`| --- | --- |`<br>`| Header | Title |`<br>`| Paragraph | Text |`
Fenced Code Block | ```` ``` ````<br>`{`<br>`"firstName": "John",`<br>`"lastName": "Smith",`<br>`"age": 25`<br>`}`<br>```` ``` ````
Footnote | `Here's a sentence with a footnote. `<br><br>`: This is the footnote.`
Heading ID | `### My Great Heading {#custom-id}`
Definition List | `term`<br>`: definition`
Strikethrough | `~~The world is flat.~~`
Task List | `- [x] Write the press release`<br>`- [ ] Update the website`<br>`- [ ] Contact the media`
Emoji | `(see also Copying and Pasting Emoji) That is so funny! :joy:`
Highlight | `I need to highlight these ==very important words==.`
Subscript | `H~2~O`
Superscript | `X^2^`

## Downloads

Markdown Cheat Sheet
[You can download this cheat sheet as a Markdown file for use in your Markdown application.](https://www.markdownguide.org/assets/markdown-cheat-sheet.md)

0 comments on commit 7f408be

Please sign in to comment.