Markdown Page Example: Difference between revisions

From sandbox
Jump to navigation Jump to search
← Older editNewer edit →
Gfc (talk | contribs)
Bureaucrats, sandbox-editors, Administrators, Widget editors
1,961 edits
No edit summary
Gfc (talk | contribs)
Bureaucrats, sandbox-editors, Administrators, Widget editors
1,961 edits
No edit summary
Line 7: Line 7:




# Markdown Cheat Sheet


---
Thanks for visiting [The Markdown Guide](https://www.markdownguide.org)!
 
# h1 Heading 8-)
## h2 Heading
### h3 Heading
#### h4 Heading
##### h5 Heading
###### h6 Heading


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).


## Horizontal Rules
## 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


## Typographic replacements
**bold text**


Enable typographer option to see result.
### Italic


(c) (C) (r) (R) (tm) (TM) (p) (P) +-
*italicized text*


test.. test... test..... test?..... test!....
### Blockquote


!!!!!! ???? ,,  -- ---
> blockquote


"Smartypants, double quotes" and 'single quotes'
### Ordered List


1. First item
2. Second item
3. Third item


## Emphasis
### Unordered List


**This is bold text**
- First item
- Second item
- Third item


__This is bold text__
### Code


*This is italic text*
`code`


_This is italic text_
### Horizontal Rule


~~Strikethrough~~
---
 
 
## Blockquotes
 
 
> Blockquotes can also be nested...
>> ...by using additional greater-than signs right next to each other...
> > > ...or with spaces between arrows.
 
 
## Lists
 
Unordered
 
+ Create a list by starting a line with `+`, `-`, or `*`
+ Sub-lists are made by indenting 2 spaces:
  - Marker character change forces new list start:
    * Ac tristique libero volutpat at
    + Facilisis in pretium nisl aliquet
    - Nulla volutpat aliquam velit
+ Very easy!
 
Ordered
 
1. Lorem ipsum dolor sit amet
2. Consectetur adipiscing elit
3. Integer molestie lorem at massa
 
 
1. You can use sequential numbers...
1. ...or keep all the numbers as `1.`


Start numbering with offset:
### Link


57. foo
[Markdown Guide](https://www.markdownguide.org)
1. bar


### Image


## Code
![alt text](https://www.markdownguide.org/assets/images/tux.png)


Inline `code`
## Extended Syntax


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


    // Some comments
### Table
    line 1 of code
    line 2 of code
    line 3 of code


| Syntax | Description |
| ----------- | ----------- |
| Header | Title |
| Paragraph | Text |


Block code "fences"
### Fenced Code Block


```
```
Sample text here...
{
```
  "firstName": "John",
 
  "lastName": "Smith",
Syntax highlighting
   "age": 25
 
}
``` js
var foo = function (bar) {
   return bar++;
};
 
console.log(foo(5));
```
```


## Tables
### Footnote
 
| Option | Description |
| ------ | ----------- |
| data  | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext    | extension to be used for dest files. |
 
Right aligned columns
 
| Option | Description |
| ------:| -----------:|
| data  | path to data files to supply the data that will be passed into templates. |
| engine | engine to be used for processing templates. Handlebars is the default. |
| ext    | extension to be used for dest files. |
 
 
## Links
 
[link text](http://dev.nodeca.com)
 
[link with title](http://nodeca.github.io/pica/demo/ "title text!")
 
Autoconverted link https://github.com/nodeca/pica (enable linkify to see)
 
 
## Images
 
![Minion](https://octodex.github.com/images/minion.png)
![Stormtroopocat](https://octodex.github.com/images/stormtroopocat.jpg "The Stormtroopocat")
 
Like links, Images also have a footnote style syntax
 
![Alt text][id]
 
With a reference later in the document defining the URL location:
 
[id]: https://octodex.github.com/images/dojocat.jpg  "The Dojocat"
 
 
## Plugins
 
The killer feature of `markdown-it` is very effective support of
[syntax plugins](https://www.npmjs.org/browse/keyword/markdown-it-plugin).
 
 
### [Emojies](https://github.com/markdown-it/markdown-it-emoji)
 
> Classic markup: :wink: :crush: :cry: :tear: :laughing: :yum:
>
> Shortcuts (emoticons): :-) :-( 8-) ;)
 
see [how to change output](https://github.com/markdown-it/markdown-it-emoji#change-output) with twemoji.
 
 
### [Subscript](https://github.com/markdown-it/markdown-it-sub) / [Superscript](https://github.com/markdown-it/markdown-it-sup)
 
- 19^th^
- H~2~O
 
 
### [\<ins>](https://github.com/markdown-it/markdown-it-ins)
 
++Inserted text++
 
 
### [\<mark>](https://github.com/markdown-it/markdown-it-mark)
 
==Marked text==
 
 
### [Footnotes](https://github.com/markdown-it/markdown-it-footnote)
 
Footnote 1 link[^first].
 
Footnote 2 link[^second].
 
Inline footnote^[Text of inline footnote] definition.
 
Duplicated footnote reference[^second].
 
[^first]: Footnote **can have markup**
 
    and multiple paragraphs.


[^second]: Footnote text.
Here's a sentence with a footnote. [^1]


[^1]: This is the footnote.


### [Definition lists](https://github.com/markdown-it/markdown-it-deflist)
### Heading ID


Term 1
### My Great Heading {#custom-id}


:  Definition 1
### Definition List
with lazy continuation.


Term 2 with *inline markup*
term
: definition


:  Definition 2
### Strikethrough


        { some code, part of Definition 2 }
~~The world is flat.~~


    Third paragraph of definition 2.
### Task List


_Compact style:_
- [x] Write the press release
- [ ] Update the website
- [ ] Contact the media


Term 1
### Emoji
  ~ Definition 1


Term 2
That is so funny! :joy:
  ~ Definition 2a
  ~ Definition 2b


(See also [Copying and Pasting Emoji](https://www.markdownguide.org/extended-syntax/#copying-and-pasting-emoji))


### [Abbreviations](https://github.com/markdown-it/markdown-it-abbr)
### Highlight


This is HTML abbreviation example.
I need to highlight these ==very important words==.


It converts "HTML", but keep intact partial entries like "xxxHTMLyyy" and so on.
### Subscript


*[HTML]: Hyper Text Markup Language
H~2~O


### [Custom containers](https://github.com/markdown-it/markdown-it-container)
### Superscript


::: warning
X^2^
*here be dragons*
:::

Revision as of 18:47, 5 May 2022

Template:MARKDOWN


  • Under Construction


  1. Markdown Cheat Sheet

Thanks for visiting [The Markdown Guide](https://www.markdownguide.org)!

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).

    1. Basic Syntax

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

      1. Heading
  1. H1
    1. H2
      1. H3
      1. Bold
    • bold text**
      1. Italic
  • italicized text*
      1. Blockquote

> blockquote

      1. Ordered List

1. First item 2. Second item 3. Third item

      1. Unordered List

- First item - Second item - Third item

      1. Code

`code`

      1. Horizontal Rule

---

      1. Link

[Markdown Guide](https://www.markdownguide.org)

      1. Image

![alt text](https://www.markdownguide.org/assets/images/tux.png)

    1. Extended Syntax

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

      1. Table

| Syntax | Description | | ----------- | ----------- | | Header | Title | | Paragraph | Text |

      1. Fenced Code Block

``` { 

 "firstName": "John",
 "lastName": "Smith",
 "age": 25

} ```

      1. Footnote

Here's a sentence with a footnote. [^1]

[^1]: This is the footnote.

      1. Heading ID
      1. My Great Heading {#custom-id}
      1. Definition List

term

definition
      1. Strikethrough

~~The world is flat.~~

      1. Task List

- [x] Write the press release - [ ] Update the website - [ ] Contact the media

      1. Emoji

That is so funny! :joy:

(See also [Copying and Pasting Emoji](https://www.markdownguide.org/extended-syntax/#copying-and-pasting-emoji))

      1. Highlight

I need to highlight these ==very important words==.

      1. Subscript

H~2~O

      1. Superscript

X^2^

Retrieved from "https://sandbox.umd.edu/wiki/index.php?title=Markdown_Page_Example&oldid=2589"