mirror of
https://github.com/mattermost/mattermost.git
synced 2025-02-25 18:55:24 -06:00
Update test-markdown.md
1) Add many corner cases we've hit in the past 2) Remove tables to put it in it's own .md test file 3) Remove lists as I've submitted a PR for a new .md file for those cases
This commit is contained in:
139
doc/developer/tests/test-markdown-basics.md
Normal file
139
doc/developer/tests/test-markdown-basics.md
Normal file
@@ -0,0 +1,139 @@
|
||||
# Basic Markdown Testing
|
||||
Tests for text style, code blocks, in-line code and images, lines, block quotes, and headings.
|
||||
|
||||
### Text Style
|
||||
|
||||
**The following text should render as:**
|
||||
_Italics_
|
||||
*Italics*
|
||||
**Bold**
|
||||
***Bold-italics***
|
||||
**_Bold-italics_**
|
||||
~~Strikethrough~~
|
||||
|
||||
This sentence contains **bold**, _italic_, ***bold-italic***, and ~~stikethrough~~ text.
|
||||
|
||||
**The following should render as normal text:**
|
||||
Normal Text_
|
||||
_Normal Text
|
||||
_Normal Text*
|
||||
|
||||
### Code Blocks
|
||||
|
||||
```
|
||||
This text should render in a code block
|
||||
```
|
||||
|
||||
**The following markdown should not render:**
|
||||
```
|
||||
_Italics_
|
||||
*Italics*
|
||||
**Bold**
|
||||
***Bold-italics***
|
||||
**Bold-italics_**
|
||||
~~Strikethrough~~
|
||||
:) :-) ;) ;-) :o :O :-o :-O
|
||||
:bamboo: :gift_heart: :dolls: :school_satchel: :mortar_board:
|
||||
# Heading 1
|
||||
## Heading 2
|
||||
### Heading 3
|
||||
#### Heading 4
|
||||
##### Heading 5
|
||||
###### Heading 6
|
||||
> Block Quote
|
||||
- List
|
||||
- List Sub-item
|
||||
[Link](http://i.giphy.com/xNrM4cGJ8u3ao.gif)
|
||||
[](https://github.com/mattermost/platform)
|
||||
| Left-Aligned Text | Center Aligned Text | Right Aligned Text |
|
||||
| :------------ |:---------------:| -----:|
|
||||
| Left column 1 | this text | $100 |
|
||||
```
|
||||
|
||||
**The following links should not auto-link or generate previews:**
|
||||
```
|
||||
GIF: http://i.giphy.com/xNrM4cGJ8u3ao.gif
|
||||
Website: https://en.wikipedia.org/wiki/Dolphin
|
||||
```
|
||||
|
||||
**The following should appear as a carriage return separating two lines of text:**
|
||||
```
|
||||
Line #1 followed by a blank line
|
||||
|
||||
Line #2 following a blank line
|
||||
```
|
||||
|
||||
### In-line Code
|
||||
|
||||
The word `monospace` should render as in-line code.
|
||||
|
||||
The following markdown in-line code should not render:
|
||||
`_Italics_`, `*Italics*`, `**Bold**`, `***Bold-italics***`, `**Bold-italics_**`, `~~Strikethrough~~`, `:)` , `:-)` , `;)` , `:-O` , `:bamboo:` , `:gift_heart:` , `:dolls:` , `# Heading 1`, `## Heading 2`, `### Heading 3`, `#### Heading 4`, `##### Heading 5`, `###### Heading 6`
|
||||
|
||||
This GIF link should not preview: `http://i.giphy.com/xNrM4cGJ8u3ao.gif`
|
||||
This link should not auto-link: `https://en.wikipedia.org/wiki/Dolphin`
|
||||
|
||||
This sentence with `
|
||||
in-line code
|
||||
` should appear on one line.
|
||||
|
||||
### In-line Images
|
||||
|
||||
Mattermost/platform build status: [](https://travis-ci.org/mattermost/platform)
|
||||
|
||||
GitHub favicon: 
|
||||
|
||||
GIF Image:
|
||||

|
||||
|
||||
4K Wallpaper Image (11Mb):
|
||||

|
||||
|
||||
Panorama Image:
|
||||

|
||||
|
||||
Tall Portrait Image:
|
||||

|
||||
|
||||
|
||||
### Lines
|
||||
|
||||
Three lines should render with text between them:
|
||||
|
||||
Text above line
|
||||
|
||||
***
|
||||
|
||||
Text between lines
|
||||
|
||||
---
|
||||
|
||||
Text between lines
|
||||
___
|
||||
|
||||
Text below line
|
||||
|
||||
### Block Quotes
|
||||
|
||||
>This text should render in a block quote.
|
||||
|
||||
**The following markdown should render within the block quote:**
|
||||
> #### Heading 4
|
||||
> _Italics_, *Italics*, **Bold**, ***Bold-italics***, **Bold-italics_**, ~~Strikethrough~~
|
||||
> :) :-) ;) :-O :bamboo: :gift_heart: :dolls:
|
||||
|
||||
**The following text should render in two block quotes separated by one line of text:**
|
||||
> Block quote 1
|
||||
|
||||
Text between block quotes
|
||||
|
||||
> Block quote 2
|
||||
|
||||
### Headings
|
||||
|
||||
# Heading 1 font size
|
||||
## Heading 2 font size
|
||||
### Heading 3 font size
|
||||
#### Heading 4 font size
|
||||
##### Heading 5 font size
|
||||
###### Heading 6 font size
|
||||
@@ -1,25 +0,0 @@
|
||||
# Markdown tests
|
||||
|
||||
Paste the following tests into Mattermost to test markdown support.
|
||||
|
||||
```
|
||||
# This should render as Heading 1 font size
|
||||
## This should render as Heading 2 font size
|
||||
### This should render as Heading 3 font size
|
||||
#### This should render as Heading 4 font size
|
||||
##### This should render as Heading 5 font size
|
||||
###### This should render as Heading 6 font size
|
||||
~~This should show strikethrough formatting~~
|
||||
**This should be bold**
|
||||
```
|
||||
|
||||
Here is how it should render:
|
||||
|
||||
# This should render as Heading 1 font size
|
||||
## This should render as Heading 2 font size
|
||||
### This should render as Heading 3 font size
|
||||
#### This should render as Heading 4 font size
|
||||
##### This should render as Heading 5 font size
|
||||
###### This should render as Heading 6 font size
|
||||
~~This should show strikethrough formatting~~
|
||||
**This should be bold**
|
||||
Reference in New Issue
Block a user