技术宅的结界

 找回密码
 立即注册→加入我们

QQ登录

只需一步,快速开始

搜索
热搜: 下载 VB C 实现 编写
查看: 49|回复: 3
收起左侧

【技巧分享】如何使用本论坛的Markdown语法(持续更新)

[复制链接]

8

主题

21

帖子

417

积分

用户组: 中·技术宅

UID
6047
精华
2
威望
55 点
宅币
226 个
贡献
50 次
宅之契约
0 份
在线时间
11 小时
注册时间
2020-7-11
发表于 2020-7-28 01:01:08 | 显示全部楼层 |阅读模式

欢迎访问技术宅的结界,请注册或者登录吧。

您需要 登录 才可以下载或查看,没有帐号?立即注册→加入我们

x
本帖最后由 nanako 于 2020-7-28 18:30 编辑

MARKDOWN入门指南

===========================
该文章用来测试和展示书写README的各种markdown语法。本论坛的markdown语法在标准的markdown语法基础上做了扩充。
PS:
1.本论坛目前无法支持页内锚点链接,只做了解即可.
2.由于没有后置库支持,图片只能使用外链


目录

横线


***、---、___可以显示横线效果




标题(使用“#”来表示标题级数)

# 一级标题  
## 二级标题  
### 三级标题  
#### 四级标题  
##### 五级标题  
###### 六级标题  

一级标题

二级标题

三级标题

四级标题

五级标题
六级标题

文本

普通文本

这是一段普通的文本

单行文本

Hello,大家好,我是nanako。

在一行开头加入1个Tab或者4个空格。

文本块

语法1

在连续几行的文本开头加入1个Tab或者4个空格。

欢迎到访
很高兴见到您
祝您,早上好,中午好,下午好,晚安

语法2

使用一对各三个的反引号:

欢迎到访
很高兴见到您
欢迎到访
很高兴见到您

该语法也可以实现代码高亮,见代码高亮

文字高亮

文字高亮功能能使行内部分文字高亮,使用一对反引号。
语法:

`linux` `网络编程` `socket` `epoll` 

效果:linux 网络编程 socket epoll

也适合做一篇文章的tag

换行

直接回车不能换行,
可以在上一行文本后面补两个空格,
这样下一行的文本就换行了。

或者就是在两行文本直接加一个空行。

也能实现换行效果,不过这个行间距有点大。

斜体、粗体、删除线

语法 效果
*斜体1* 斜体1
_斜体2_ 斜体2
**粗体1** 粗体1
__粗体2__ 粗体2
这是一个 ~~删除线~~ 这是一个 删除线
***斜粗体1*** 斜粗体1
___斜粗体2___ 斜粗体2
***~~斜粗体删除线1~~*** 斜粗体删除线1
~~***斜粗体删除线2***~~ 斜粗体删除线2
斜体、粗体、删除线可混合使用

图片

基本格式:

![alt](URL title)

alt和title即对应HTML中的alt和title属性(都可省略):

  • alt表示图片显示失败时的替换文本
  • title表示鼠标悬停在图片时的显示文本(注意这里要加引号)

URL即图片的url地址,如果引用本仓库中的图片,直接使用相对路径就可了,如:

https://XXX.com/xxx.gif
# 语法 效果
1 ![baidu](http://www.baidu.com/img/bdlogo.gif "百度logo") baidu
2 ![][code-past] ![][code-past]

注意例2的写法使用了URL标识符的形式,在链接一节有介绍。

在文末有code-past的定义:

[code-past]:https://img-blog.csdnimg.cn/201908060004034.png

链接

链接外部URL

# 语法 效果
1 [0xAA55](http://0xAA55.com "悬停显示:0xAA55论坛") 0xAA55

语法2由两部分组成:

  • 第一部分使用两个中括号,[ ]里的标识符(本例中zhihu),可以是数字,字母等的组合,标识符上下对应就行了(姑且称之为URL标识符
  • 第二部分标记实际URL。

使用URL标识符能达到复用的目的,一般把全文所有的URL标识符统一放在文章末尾,这样看起来比较干净。

图片链接

给图片加链接的本质是混合图片显示语法和普通的链接语法。普通的链接中[ ]内部是链接要显示的文本,而图片链接[ ]里面则是要显示的图片。
直接混合两种语法当然可以,但是十分啰嗦,为此我们可以使用URL标识符的形式。

# 语法 效果
1 [![weibo-logo]](http://weibo.com/linpiaochen) ![weibo-logo]

因为图片本身和链接本身都支持URL标识符的形式,所以图片链接也可以很简洁(见例3)。
注意,此时鼠标悬停时显示的文字是图片的title,而非链接本身的title了。

本文URL标识符都放置于文末

锚点

其实呢,每一个标题都是一个锚点,和HTML的锚点(#)类似,比如我们

语法 效果
[回到顶部](#readme) 回到顶部

不过要注意,标题中的英文字母都被转化为小写字母了。

以前MD对中文支持的不好,所以中文标题不能正确识别为锚点,但是现在已经没问题啦!

列表

无序列表

语法

* 昵称:果冻
- 别名:老王
* 英文名:Jelly

效果

  • 昵称:nanako
  • 别名:老李
  • 英文名:Nana

多级无序列表

语法

* 编程语言
    * 脚本语言
        * Python

效果

  • 编程语言
    • 脚本语言
      • Python

一级有序列表

语法

就是在数字后面加一个点,再加一个空格。不过看起来起来可能不够明显。

面向对象的三个基本特征:

1. 封装
2. 继承
3. 多态

效果

面向对象的三个基本特征:

  1. 封装
  2. 继承
  3. 多态

多级有序列表

和无序列表一样,有序列表也有多级结构。

语法

1. 这是一级的有序列表,数字1还是1
   1. 这是二级的有序列表,阿拉伯数字在显示的时候变成了罗马数字
      1. 这是三级的有序列表,数字在显示的时候变成了英文字母

效果 (本论坛不可见)

  1. 这是一级的有序列表,数字1还是1
    1. 这是二级的有序列表,阿拉伯数字在显示的时候变成了罗马数字
      1. 这是三级的有序列表,数字在显示的时候变成了英文字母

复选框列表

语法

- [x] 需求分析
- [x] 系统设计
- [x] 详细设计
- [ ] 编码
- [ ] 测试
- [ ] 交付

效果

  • [x] 需求分析
  • [x] 系统设计
  • [x] 详细设计
  • [ ] 编码
  • [ ] 测试
  • [ ] 交付

您可以使用这个功能来标注某个项目各项任务的完成情况。

Tip:

当我们在GitHub的issue中使用该语法是可以实时点击复选框来勾选或解除勾选的,而无需修改issue原文。

块引用

常用于引用文本

文本摘自《深入理解计算机系统》P27

 令人吃惊的是,在哪种字节顺序是合适的这个问题上,人们表现得非常情绪化。实际上术语“little endian”(小端)和“big endian”(大端)出自Jonathan Swift的《格利佛游记》一书,其中交战的两个派别无法就应该从哪一端打开一个半熟的鸡蛋达成一致。因此,争论沦为关于社会政治的争论。只要选择了一种规则并且始终如一的坚持,其实对于哪种字节排序的选择都是任意的。

“端”(endian)的起源
以下是Jonathan Swift在1726年关于大小端之争历史的描述:
“……下面我要告诉你的是,Lilliput和Blefuscu这两大强国在过去36个月里一直在苦战。战争开始是由于以下的原因:我们大家都认为,吃鸡蛋前,原始的方法是打破鸡蛋较大的一端,可是当今的皇帝的祖父小时候吃鸡蛋,一次按古法打鸡蛋时碰巧将一个手指弄破了,因此他的父亲,当时的皇帝,就下了一道敕令,命令全体臣民吃鸡蛋时打破较小的一端,违令者重罚。”

块引用有多级结构

语法

> 数据结构
>> 树
>>> 二叉树
>>>> 平衡二叉树
>>>>> 满二叉树

效果

数据结构

二叉树

平衡二叉树

满二叉树

代码高亮

语法

在三个反引号后面加上编程语言的名字,另起一行开始写代码,最后一行再加上三个反引号。

效果

public static void main(String[]args){} //Java
int main(int argc, char *argv[]) //C
echo "hello GitHub" #Bash
document.getElementById("myH1").innerHTML="Welcome to my Homepage"; //javascipt
string &operator+(const string& A,const string& B) //cpp

表格

表头1 表头2
表格单元 表格单元
表格单元 表格单元
表头1 表头2
表格单元 表格单元
表格单元 表格单元

对齐

表格可以指定对齐方式

左对齐 居中 右对齐
col 3 is some wordy text $1600
col 2 is centered $12
zebra stripes are neat $1

混合其他语法

表格单元中的内容可以和其他大多数GFM语法配合使用,如:  

使用普通文本的删除线,斜体等效果

名字 描述
Help Display the help window.
Close Closes a window

表格中嵌入图片(链接)

其实前面介绍图片显示、图片链接的时候为了清晰就是放在在表格中显示的。

图片 描述
![baidu][baidu-logo] 百度

表情(实验用法,本论坛不支持,已知支持GitHub)

Markdown语法支持添加emoji表情,输入不同的符号码(两个冒号包围的字符)可以显示出不同的表情。

比如:blush:,可以显示:blush:。

具体每一个表情的符号码,可以查询GitHub的官方网页http://www.emoji-cheat-sheet.com

diff语法

版本控制的系统中都少不了diff的功能,即展示一个文件内容的增加与删除。
GFM中可以显示的展示diff效果。使用绿色表示新增,红色表示删除。

语法

其语法与代码高亮类似,只是在三个反引号后面写diff,
并且其内容中,可以用 +开头表示新增,-开头表示删除。
另外还有有 !#的语法。

效果

+ 人闲桂花落,
- 夜静春山空。
! 月出惊山鸟,
# 时鸣春涧中。

好啦,这期教程就到这里啦,相信大家对于论坛的MD语言又有了更细致的了解吧www

下期nanako将会更新关于markdown语法中公式和流程图的绘制方法


主编 http://weibo.com/linpiaochen
转载改编 mailto:nanako@mailnesia.com

评分

参与人数 2威望 +20 宅币 +60 贡献 +20 收起 理由
0xAA55 + 10 + 30 + 10 赞!
watermelon + 10 + 30 + 10 牛的

查看全部评分

回复

使用道具 举报

8

主题

21

帖子

417

积分

用户组: 中·技术宅

UID
6047
精华
2
威望
55 点
宅币
226 个
贡献
50 次
宅之契约
0 份
在线时间
11 小时
注册时间
2020-7-11
 楼主| 发表于 2020-7-28 01:31:50 | 显示全部楼层
本帖最后由 nanako 于 2020-7-28 01:46 编辑

接下来我把本文章的全部markdown语句放出来,供大家参考。
推荐一个顶级的markdown编写阅读神器:Typora。


markdown.txt

11.79 KB, 下载次数: 6

这是上文所述的markdown语言未转义形式

8

主题

21

帖子

417

积分

用户组: 中·技术宅

UID
6047
精华
2
威望
55 点
宅币
226 个
贡献
50 次
宅之契约
0 份
在线时间
11 小时
注册时间
2020-7-11
 楼主| 发表于 2020-7-28 01:39:08 | 显示全部楼层
本帖最后由 nanako 于 2020-7-28 01:40 编辑

这里是markdown专用的 .md 文件,以及我用typora的两个自定义主题为大家生成的预览效果,供大家自由下载使用

MARKDOWN入门指南.md

12.73 KB, 下载次数: 1

售价: 1 个宅币  [记录]  [购买]

白色主题效果入门指南.html

86.62 KB, 下载次数: 0

黑色主题效果入门指南.html

102.14 KB, 下载次数: 1

8

主题

21

帖子

417

积分

用户组: 中·技术宅

UID
6047
精华
2
威望
55 点
宅币
226 个
贡献
50 次
宅之契约
0 份
在线时间
11 小时
注册时间
2020-7-11
 楼主| 发表于 2020-7-28 01:42:40 | 显示全部楼层
本帖最后由 nanako 于 2020-7-28 18:31 编辑

表格

我们可以设置表格的对齐方式:

---: 设置内容和标题栏居右对齐。
:---- 设置内容和标题栏居左对齐。
:----: 设置内容和标题栏居中对齐。

实例如下:

左对齐 右对齐 居中对齐
单元格 单元格 单元格
单元格 单元格 单元格

对应的语句:

| 左对齐 | 右对齐 | 居中对齐 |
| :-----| ----: | :----: |
| 单元格 | 单元格 | 单元格 |
| 单元格 | 单元格 | 单元格 |


本版积分规则

QQ|申请友链||Archiver|手机版|小黑屋|技术宅的结界 ( 滇ICP备16008837号 )|网站地图  

GMT+8, 2020-8-5 18:00 , Processed in 0.128304 second(s), 39 queries , Gzip On.

Powered by Discuz! X3.4

Copyright © 2001-2020, Tencent Cloud.

快速回复 返回顶部 返回列表