写文章需要标题,表示标题的方法有:
使用三个=号,来代表主标题
使用三个-号,来代表子标题
如果三个-号上无文字,则会在文本中生成虚线
除了上面的标题表示方式外,还看以使用#来表示标题:
#表示一级标题
##表示二级标题,一次类推#~######(6个)代表了1~6级的标题。
##标题
对于一个大标题,一般我们都会分为几个部分来讲解或记录,这些部分的小标题我们可以使用“+ - * ”来表示,他们三者的意义是一样的,都会转换成一个点(·)这样的无序标题。要是我们写到逻辑比较强的地方要分为1、2、3等条目时,也就是有序标题,我们可以使用1. 2. 3.等数字加“.”的方式表示有序标题。
##内容
标题写完了,下来我们要写具体的内容了,我们的文章是技术文章,需要用到架构图,我们可以用以下方式表示图片:
,前面的“!”不能去掉,因为去掉后,我们就只是显示一个链接,这个链接的名字就是“别名”。
当然如果我们想在给用户介绍,这个图片的来源以及图片作者的一些解释的时候,我们可以给图片加上Url链接效果:假如用x表示图片,那么这个链接效果就是[x](目标链接Url)
,看到这里你就明白了,这个是可以嵌套使用的!
添加完了架构图片,下来我们需要引用一段原作者的名言来概括一下这张图片,我们可以使用“>被引用的文字”这种写法,来添加一段引用。(这个也是可以嵌套使用的)
添加完引用后,我们要对作者的名言进行解释,我们需要添加一个注解,添加方法如下:
“这个是名言的注解[^keynote] ”
"[^keynote]: 这个是注解"
这个注解的方式就是Key-Value的形式,他会被markdown解析成注解的样式。
解释完作者的名言我们要开始引用代码进行讲解了:
“ 使用四个空格来表示代码块”
这种用法主要是对于一些简单的代码进行表示和处理,或者也可以理解为一个文字区块,但是在这个区块中写道的一些特殊命令,markdown会按原文翻译,不会转述成他所表示的形式显示出来。如果有大量的代码要写的话,建议用下面的形式表示:
1
具体的代码
这种格式支持40多种语言,基本上满足了我们的需求。
引用完代码之后,我们需要对代码进行解释,在解释的时候我们需要对重要的词句进行加粗(使用“**被加粗的文字**”
),或者用斜体(使用“*需要斜体表示的文字*”
)进行强调。
在讲解时我们肯定会引入别的类名,这时需要用“ `类名
` ”来表示类名,这样就表示是文字内代码。
对于一些比较复杂的逻辑,我们在解释可能会引入一些公式定理来解释,我们可以使用“$v=s/t$”来在行内表示公式定理,如果一整行都是公式定理,我们可以使用“$$整行公式$$”来表示。
在我们介绍这个架构时,会有一些典型的错误,但是我们不希望不仔细的读者将它看成正确的例子,我们可以使用“反例”对中间的文字加上删除线,加以警示。
假如我们写这篇文章时候,是和别人合作的,我们可以在最后用一个表格来表示,这个骗文章的作者,以及每个人写的部分,还有字数等信息。表格的写法如下:
| 作者 | 所写章节 | 字数 |
| -- | --: | :--: |
| Ted | a.b.c章 | 1000字 |
| Annie | d.e.f章 | 1024字 |
注意此部分,"-"的个数无所谓,但是至少一个
上述中,“作者”column将会居左,“所写章节”column会居右,“字数”column会居中显示。
好了,文章完成了,我们可以使用[TOC]来给文章加个目录,并且可以使用
Tags(标签):标签1 标签2 标签3 来给文章加上标签。
OK,文章可以发表了!