重要的
在Github上查看官方文档,以了解有关编写和格式化语法的更多信息。此外,您可以通过访问GitHub ChangElog帖子来阅读Markdown上最新的更新和功能。
Markdown是一种使用纯文本格式语法编写丰富文本(格式化文本)内容的方式。它也是将纯文本格式转换为HTML的工具。
本指南将为您提供对GitHub风味降价(GFM)中的关键命令的全面理解,它是Commonmark的严格超集。您可以阅读全文,《媒介上的终极降价备忘单》。
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
< h1 >Heading 1</ h1 >
< h2 >Heading 2</ h2 >
< h3 >Heading 3</ h3 >
< h4 >Heading 4</ h4 >
< h5 >Heading 5</ h5 >
< h6 >Heading 6</ h6 >
Heading 1
=
Heading 2
-
The quick brown fox jumps over the lazy dog.
快速的棕色狐狸跳过懒狗。
Mac:命令+b
Windows:控制+b
** The quick brown fox jumps over the lazy dog. **
__ The quick brown fox jumps over the lazy dog. __
< strong >The quick brown fox jumps over the lazy dog.</ strong >
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
Mac:命令+i
Windows:控制+i
* The quick brown fox jumps over the lazy dog. *
_ The quick brown fox jumps over the lazy dog. _
< em >The quick brown fox jumps over the lazy dog.</ em >
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
** _ The quick brown fox jumps over the lazy dog. _ **
< strong >< em >The quick brown fox jumps over the lazy dog.</ em ></ strong >
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
MAC:命令+Shift+。
Windows: Control+Shift+。
> The quick brown fox jumps over the lazy dog.
< br >
> The quick brown fox jumps over the lazy dog.
>
> The quick brown fox jumps over the lazy dog.
>
> The quick brown fox jumps over the lazy dog.
< br >
> The quick brown fox jumps over the lazy dog.
> > The quick brown fox jumps over the lazy dog.
> > > The quick brown fox jumps over the lazy dog.
< br >
> ** The quick brown fox ** * jumps over the lazy dog. *
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
快速的棕色狐狸跳过懒狗。
< samp >The quick brown fox jumps over the lazy dog.</ samp >
快速的棕色狐狸跳过懒狗。
< ins >The quick brown fox jumps over the lazy dog.</ ins >
快速的棕色狐狸跳过懒狗。
~~ The quick brown fox jumps over the lazy dog. ~~
快速的棕色狐狸跳过懒狗。
< pre >
Lorem ipsum dolor sit amet, consectetur adipiscing elit. < strike >Sed do eiusmod tempor incididunt ut labore et dolore magna
aliqua.</ strike > Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat.
Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. < strike >Excepteur sint
occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.</ strike >
</ pre >
Lorem Ipsum Dolor Sit Amet,Consectur adipiscing Elit。sed do eiusmod临时裂缝ut ut labore et dolore magna 阿里夸(Aliqua)。UT Enim ad Minim veniam,Quis Nostrud练习Ullamco Laboris nisi ut equip equip ex ea Commodo Reactation。 duis aute irure dolor in prokhenderit在Volutate Velit Esse Cillum dolore eu fugiat nulla Pariatur。除了sint Occaecate cupidatat非主管,在culpa qui官员中晒太阳的穆利特动画效果
< strike >
``` js
console . log ( ' Error ' );
```
</ strike >
console . log ( 'Error' ) ;
< table >< tr >< td >The quick brown fox jumps over the lazy dog.</ td ></ tr ></ table >
快速的棕色狐狸跳过懒狗。 |
log< sub >2</ sub >(x)
Subscript < sub >The quick brown fox jumps over the lazy dog.</ sub >
log 2 (x)
下标快速棕色狐狸跳过懒狗。
2 < sup >53-1</ sup > and -2 < sup >53-1</ sup >
Superscript < sup >The quick brown fox jumps over the lazy dog.</ sup >
2 53-1和-2 53-1
上标题快速棕狐跳过懒狗。
使用Mathjax语法:
颜色名称 | 代码 | 例子 |
---|---|---|
杏 | $color{Apricot}{The quick brown fox jumps over the lazy dog.}$ | |
蓝晶 | $color{Aquamarine}{The quick brown fox jumps over the lazy dog.}$ | |
苦乐参半 | $color{Bittersweet}{The quick brown fox jumps over the lazy dog.}$ | |
黑色的 | $color{Black}{The quick brown fox jumps over the lazy dog.}$ |
完整表
快速
布朗狐狸
跳过
懒狗。
The quick
brown fox
jumps over
the lazy dog.
类方法是类对象的实例方法。创建新类时,类型Class
的对象将初始化并分配给全局常数(在这种情况下为移动设备)。
您可以在Mac上使用命令 + E或Windows上的Control + E插入内联代码。
public static String monthNames[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"};
```
public static String monthNames[] = {"January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"};
```
public static String monthNames [] = { "January" , "February" , "March" , "April" , "May" , "June" , "July" , "August" , "September" , "October" , "November" , "December" };
``` java
public static String monthNames[] = { " January " , " February " , " March " , " April " , " May " , " June " , " July " , " August " , " September " , " October " , " November " , " December " };
```
请参阅此和此github文档以查找所有有效的关键字。
# # git diff a/test.txt b/test.txt
diff --git a/a/test.txt b/b/test.txt
index 309ee57..c995021 100644
--- a/a/test.txt
+++ b/b/test.txt
@@ -1,8 +1,6 @@
- The quick brown fox jumps over the lazy dog
+ The quick brown fox jumps over the lazy cat
a
- b
c
d
- e
f
``` diff
# # git diff a/test.txt b/test.txt
diff --git a/a/test.txt b/b/test.txt
index 309ee57..c995021 100644
--- a/a/test.txt
+++ b/b/test.txt
@@ -1,8 +1,6 @@
- The quick brown fox jumps over the lazy dog
+ The quick brown fox jumps over the lazy cat
a
- b
c
d
- e
f
```
- Text in Red
+ Text in Green
! Text in Orange
# Text in Gray
@@ Text in Purple and bold @@
``` diff
- Text in Red
+ Text in Green
! Text in Orange
# Text in Gray
@@ Text in Purple and bold @@
```
< p align = " left " >
< img src = " https://images.unsplash.com/photo-1415604934674-561df9abf539?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=2772&q=80 " width = " 100 " height = " 100 " border = " 10 " />
</ p >
< p align = " center " >
< img src = " https://images.unsplash.com/photo-1415604934674-561df9abf539?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=2772&q=80 " width = " 100 " height = " 100 " border = " 10 " />
</ p >
< p align = " right " >
< img src = " https://images.unsplash.com/photo-1415604934674-561df9abf539?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=2772&q=80 " width = " 100 " height = " 100 " border = " 10 " />
</ p >
< h3 align = " center " > My latest Medium posts </ h3 >
< table >
< tr >
< td width = " 33% " " >
The quick brown fox jumps over the lazy dog.
</ td >
< td width = " 33% " >
The quick brown fox jumps over the lazy dog.
</ td >
< td width = " 33% " >
The quick brown fox jumps over the lazy dog.
</ td >
</ tr >
</ table >
快速的棕色狐狸跳过懒狗。 | 快速的棕色狐狸跳过懒狗。 | 快速的棕色狐狸跳过懒狗。 |
| Default | Left align | Center align | Right align |
| - | :- | :-: | -: |
| 9999999999 | 9999999999 | 9999999999 | 9999999999 |
| 999999999 | 999999999 | 999999999 | 999999999 |
| 99999999 | 99999999 | 99999999 | 99999999 |
| 9999999 | 9999999 | 9999999 | 9999999 |
| Default | Left align | Center align | Right align |
| ---------- | :--------- | :----------: | ----------: |
| 9999999999 | 9999999999 | 9999999999 | 9999999999 |
| 999999999 | 999999999 | 999999999 | 999999999 |
| 99999999 | 99999999 | 99999999 | 99999999 |
| 9999999 | 9999999 | 9999999 | 9999999 |
Default | Left align | Center align | Right align
---------- | :--------- | :----------: | ----------:
9999999999 | 9999999999 | 9999999999 | 9999999999
999999999 | 999999999 | 999999999 | 999999999
99999999 | 99999999 | 99999999 | 99999999
9999999 | 9999999 | 9999999 | 9999999
默认 | 左对齐 | 中心对齐 | 正确对齐 |
---|---|---|---|
999999999 | 999999999 | 999999999 | 999999999 |
99999999 | 99999999 | 99999999 | 99999999 |
9999999 | 9999999 | 9999999 | 9999999 |
9999999 | 9999999 | 9999999 | 9999999 |
默认 | 左对齐 | 中心对齐 | 正确对齐 |
---|---|---|---|
999999999 | 999999999 | 999999999 | 999999999 |
99999999 | 99999999 | 99999999 | 99999999 |
9999999 | 9999999 | 9999999 | 9999999 |
9999999 | 9999999 | 9999999 | 9999999 |
默认 | 左对齐 | 中心对齐 | 正确对齐 |
---|---|---|---|
999999999 | 999999999 | 999999999 | 999999999 |
99999999 | 99999999 | 99999999 | 99999999 |
9999999 | 9999999 | 9999999 | 9999999 |
9999999 | 9999999 | 9999999 | 9999999 |
< table >
< tr >
< th >Heading 1</ th >
< th >Heading 2</ th >
</ tr >
< tr >
< td >
| A | B | C |
| -- | -- | -- |
| 1 | 2 | 3 |
</ td >< td >
| A | B | C |
| -- | -- | -- |
| 1 | 2 | 3 |
</ td ></ tr > </ table >
标题1 | 标题2 | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
| A | B | C |
| --- | --- | --- |
| 1 | 2 | 3 < br /> 4 < br /> 5 |
一个 | b | c |
---|---|---|
1 | 2 | 3 4 5 |
< table >
< tr >
< th >Before Hoisting</ th >
< th >After Hoisting</ th >
</ tr >
< tr >
< td >
< pre lang = " js " >
console.log(fullName); // undefined
fullName = "Dariana Trahan";
console.log(fullName); // Dariana Trahan
var fullName;
</ pre >
</ td >
< td >
< pre lang = " js " >
var fullName;
console.log(fullName); // undefined
fullName = "Dariana Trahan";
console.log(fullName); // Dariana Trahan
</ pre >
</ td >
</ tr >
</ table >
提升之前 | 升起后 |
---|---|
console . log ( fullName ) ; // undefined
fullName = "Dariana Trahan" ;
console . log ( fullName ) ; // Dariana Trahan
var fullName ; | var fullName ;
console . log ( fullName ) ; // undefined
fullName = "Dariana Trahan" ;
console . log ( fullName ) ; // Dariana Trahan |
[ The-Ultimate-Markdown-Cheat-Sheet ] ( https://github.com/lifeparticle/Markdown-Cheatsheet )
式标志性的切片
[ The-Ultimate-Markdown-Cheat-Sheet ] [ reference text ]
[ The-Ultimate-Markdown-Cheat-Sheet ] [ 1 ]
[ Markdown-Cheat-Sheet ]
[ reference text ] : https://github.com/lifeparticle/Markdown-Cheatsheet
[ 1 ] : https://github.com/lifeparticle/Markdown-Cheatsheet
[ Markdown-Cheat-Sheet ] : https://github.com/lifeparticle/Markdown-Cheatsheet
式标志性的切片
式标志性的切片
降级欺骗
脚注。 1
其他一些重要的脚注。 2
Footnote. [ ^ 1 ]
Some other important footnote. [ ^ 2 ]
[ ^ 1 ] : This is footnote number one.
[ ^ 2 ] : Here is the second footnote.
[ Example of a relative link ] ( rl.md )
相对链接的示例
Visit https://github.com/
访问https://github.com/
Email at [email protected]
电子邮件示例@example.com
您可以使用BinaryTree创建降价表。
您可以使用BinaryTree创建降价表。
< https://github.com/ >
https://github.com/
[ BinaryTree ] ( https://binarytree.dev/ )
Binarytree
Alt文字和标题是可选的。
![ alt text ] ( https://images.unsplash.com/photo-1415604934674-561df9abf539?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=100&q=80 " Title text ")
![ alt text ] [ image ]
[ image ] : https://images.unsplash.com/photo-1415604934674-561df9abf539?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=100&q=80 " Title text "
< img src = " https://images.unsplash.com/photo-1415604934674-561df9abf539?ixlib=rb-1.2.1&ixid=eyJhcHBfaWQiOjEyMDd9&auto=format&fit=crop&w=2772&q=80 " width = " 100 " height = " 100 " border = " 10 " />
< img src = " https://media.giphy.com/media/qLHzYjlA2FW8g/giphy.gif " />
< img src = " https://img.shields.io/badge/theultimatemarkdowncheatsheet-brightgreen.svg " />
[ ![ BinaryTree ] ( https://github.com/lifeparticle/lifeparticle/blob/master/gh_social_light.png )] ( https://binarytree.dev/ )
< a href = ' https://binarytree.dev/ ' target = ' _blank ' > < img src = ' https://github.com/lifeparticle/lifeparticle/blob/master/gh_social_light.png ' /> </ a >
HTML <picture>
元素以及prefers-color-scheme
Media功能,使您可以根据用户的配色方案偏好动态调整图像,为浅色和深色模式提供选项。
例如,下面的代码片段演示了当用户的设备设置为黑暗模式时如何显示以深为主题的二进制徽标,以及用于光模式设置的轻为主题的二进制徽标徽标:
< picture >
< source media = " (prefers-color-scheme: dark) " srcset = " https://github.com/lifeparticle/lifeparticle/blob/master/gh_social_dark.png " >
< source media = " (prefers-color-scheme: light) " srcset = " https://github.com/lifeparticle/lifeparticle/blob/master/gh_social_light.png " >
< img alt = " BinaryTree " src = " https://github.com/lifeparticle/lifeparticle/blob/master/gh_social_light.png " width = " 200 " >
</ picture >
[ ![ Badge ] [ Logo-dark ]] ( https://binarytree.dev#gh-dark-mode-only )
[ ![ Badge ] [ Logo-light ]] ( https://binarytree.dev#gh-light-mode-only )
[ Logo-dark ] : https://github-readme-stats.vercel.app/api?username=lifeparticle&theme=graywhite&show_icons=true#gh-light-mode-only
[ Logo-light ] : https://github-readme-stats.vercel.app/api?username=lifeparticle&theme=dark&show_icons=true#gh-dark-mode-only
< a href = " https://github.com/anuraghazra/github-readme-stats#gh-light-mode-only " >
< img src = " https://github-readme-stats.vercel.app/api?username=lifeparticle&theme=graywhite&show_icons=true#gh-light-mode-only " width = " 350 " alt = " This image shows a summary of Mahbub Zaman's GitHub statistics. " />
</ a >
< a href = " https://github.com/anuraghazra/github-readme-stats#gh-dark-mode-only " >
< img src = " https://github-readme-stats.vercel.app/api?username=lifeparticle&theme=dark&show_icons=true#gh-dark-mode-only " width = " 350 " alt = " This image shows a summary of Mahbub Zaman's GitHub statistics. " />
</ a >
![ GitHub forks ] ( https://img.shields.io/github/forks/lifeparticle/Markdown-Cheatsheet?style=for-the-badge )
MAC:命令+Shift+7
Windows: Control+Shift+7
1 . One
2 . Two
3 . Three
1 . First level
1 . Second level
- Third level
- Fourth level
2 . First level
1 . Second level
3 . First level
1 . Second level
Mac:命令+Shift+8
Windows: Control+Shift+8
* 1
* 2
* 3
+ 1
+ 2
+ 3
- 1
- 2
- 3
- First level
- Second level
- Third level
- Fourth level
- First level
- Second level
- First level
- Second level
< ul >
< li >First item</ li >
< li >Second item</ li >
< li >Third item</ li >
< li >Fourth item</ li >
</ ul >
- [x] Fix Bug 223
- [ ] Add Feature 33
- [ ] Add unit tests
< kbd >cmd + shift + p</ kbd >
CMD + Shift + P
< kbd > < br > cmd + shift + p < br > </ kbd >
CMD + Shift + P
< kbd > [ Markdown-Cheatsheet ] ( https://github.com/lifeparticle/Markdown-Cheatsheet ) </ kbd >
Markdown-Cheatsheet
[ < kbd >Markdown-Cheatsheet</ kbd > ] ( https://github.com/lifeparticle/Markdown-Cheatsheet )
Markdown-Cheatsheet
Markdown-Cheatsheet
< kbd > < br > [ Markdown-Cheatsheet ] ( https://github.com/lifeparticle/Markdown-Cheatsheet ) ↗️ < br > </ kbd >
< details >
< summary >Markdown</ summary >
- < kbd > [ Markdown Editor ] ( https://binarytree.dev/me ) </ kbd >
- < kbd > [ Table Of Content ] ( https://binarytree.dev/toc ) </ kbd >
- < kbd > [ Markdown Table Generator ] ( https://binarytree.dev/md_table_generator ) </ kbd >
</ details >
---
***
___
``` mermaid
pie
"Movies" : 80
"TV shows" : 20
```
馅饼
“电影”:80
“电视节目”:20
重要的
查看有关Github的官方文档,以了解有关编写和格式化Mathjax语法的更多信息。
This is an inline math expression $x = {-b pm sqrt{b^2-4ac} over 2a}$
这是一个内联数学表达式
$$
x = {-b pm sqrt{b^2-4ac} over 2a}
$$
> [ !NOTE ]
> Essential details that users should not overlook, even when browsing quickly.
< br >
> [ !TIP ]
> Additional advice to aid users in achieving better outcomes.
< br >
> [ !IMPORTANT ]
> Vital information required for users to attain success.
< br >
> [ !WARNING ]
> Urgent content that requires immediate user focus due to possible risks.
< br >
> [ !CAUTION ]
> Possible negative outcomes resulting from an action.
笔记
即使快速浏览,用户也不应忽略用户的基本细节。
提示
其他建议,以帮助用户实现更好的结果。
重要的
用户获得成功所需的重要信息。
警告
由于可能的风险,需要立即将用户关注的紧急内容。
警告
动作可能导致的负面结果。
在问题中:
@ lifeparticle
题目中显示的示例
在Markdown文件中:
https://github.com/lifeparticle
https://github.com/lifeparticle
在问题中:
# 1
# 10
题目中显示的示例
在Markdown文件中:
https://github.com/lifeparticle/Markdown-Cheatsheet/issues/1
https://github.com/lifeparticle/Markdown-Cheatsheet/pull/10
#1
#10
在问题中:
` #ffffff `
` #000000 `
题目中显示的示例
单击代码(右上)或RAW(左上方)选项以查看Markdown代码。
笔记
确保您已经单击了Markdown文件以查看上面的视图。
在有争议的情况下,并提取请求标题。
TEST
问题
` TEST ` ISSUE
现在,Markdown中URL引用的标签自动呈现。
文档
https://github.com/lifeparticle/Markdown-Cheatsheet/labels/documentation
<!--
Lorem ipsum dolor sit amet
-->
* Asterisk
Backslash
` Backtick
{} Curly braces
. Dot
! Exclamation mark
# Hash symbol
- Hyphen symbol
() Parentheses
+ Plus symbol
[ ] Square brackets
_ Underscore`
()括号
[]方括号_台下
* Asterisk
\ Backslash
` Backtick
{ } Curly braces
. Dot
! Exclamation mark
# Hash symbol
- Hyphen symbol
( ) Parentheses
+ Plus symbol
[ ] Square brackets
_ Underscore
*星号 backslash` backtick {}卷曲括号。点!感叹号标记#哈希符号 - 连字符符号()括号 +加上符号[]方括号_ underscore
:octocat:
GitHub Markdown表情符号标记的完整列表
您可以使用<br>
插入单个线路断开。确保使用EM空间
。例如:
< table >< tr >< td > < br > The quick brown fox jumps over the lazy dog. < br > </ td ></ tr ></ table >
快速的棕色狐狸跳过懒狗。 |
或者
< table >< tr >< td > < br >< br >< br > The quick brown fox jumps over the lazy dog. < br >< br >< br > </ td ></ tr ></ table >
快速的棕色狐狸跳过懒狗。 |
首先将以下代码放在降价文件的开始
< a name = " top " ></ a >
然后在要返回到顶部的地方使用以下代码之一。
回到顶部
⬆️
[ Back to top ] ( #top )
[ : arrow_up : ] ( #top )
Bitbucket支持READMES的Markdown。另外,创建一个目录。
Azure Devops支持Wiki项目的Markdown。
您可以使用MDX在Markdown文档中编写JSX。
此读数已根据GitHub的博客文章“使您的GitHub个人资料页面可访问”的博客文章进行了优化,以供可访问性。
这是脚注第一。 ↩
这是第二个脚注。 ↩