github中README.md文件的编写(Markdown)

刚开始尝试使用github,创建新项目的时候其中的README.md文件都是默认的,即使改动也只会添加文本,翻看别人的项目时发现其中的README.md不仅有文字还有链接、图片之类的,搜索之后发现github上的README.md文件是使用的Markdown语言编写,下面整理些Markdown语言的常用语法。

语法宗旨
Markdown 的目标是实现「易读易写」。

可读性,无论如何,都是最重要的。一份使用 Markdown 格式撰写的文件应该可以直接以纯文本发布,并且看起来不会像是由许多标签或是格式指令所构成。Markdown 语法受到一些既有 text-to-HTML 格式的影响,包括Setext、atx、Textil、reStructuredText、Grutatex 和EtText,而最大灵感来源其实是纯文本电子邮件的格式。

总之, Markdown 的语法全由一些符号所组成,这些符号经过精挑细选,其作用一目了然。比如:在文字两旁加上星号,看起来就像强调。Markdown 的列表看起来,嗯,就是列表。Markdown 的区块引用看起来就真的像是引用一段文字,就像你曾在电子邮件中见过的那样。

编辑器
主流编辑器都可以编辑Markdowm文件

语法

1.标题

标题使用“#”来标识h1~h6:

# h1
## h2
### h3
#### h4
##### h5
###### h6

2.图片

图片的格式如下:

![替代文字](https://raw.githubusercontent.com/bin248163/qd/master/images/home.jpg)

方括号里面放上图片的替代文字,圆括号里面放上图片的网址,图片引用最好为项目地址,外部图片地址会有显示不全的现象。

3.链接

外部链接的格式如下:

[My blog](http://blog.qianxiaoduan.com/)

方括号里面放上链接文字,圆括号里面放上链接的地址。

相对路径的格式:

My blog [About](/index.php)

4.列表

Markdown 支持有序列表和无序列表。

无序列表使用星号、加号或是减号作为列表标记:

*   Red
*   Green
*   Blue

等同于

+   Red
+   Green
+   Blue

-   Red
-   Green
-   Blue

有序列表则使用数字接着一个英文句点:

1.   Red
2.   Green
3.   Blue

5.分割线

在一行中用三个以上的星号、减号、底线来建立一个分隔线,行内不能有其他东西。可以在星号或是减号中间插入任意数量的空格。下面每种写法都可以建立分隔线:

* * *
***
*****
- - -
---------

6.引用

Markdown 通过“>”来引用内容,可以在引用开头加一个,也可以在引用每一行的前面都加一个,引用也可以嵌套,示例如下:

> 这是一段引用
> > 这是一段二级引用

7.换行

一个 Markdown 段落是由一个或多个连续的文本行组成,它的前后要有一个以上的空行(空行的定义是显示上看起来像是空的,便会被视为空行。比方说,若某一行只包含空格和制表符,则该行也会被视为空行)。普通段落不该用空格或制表符来缩进,这样会被认为是换行。

8.代码

如果要标记一小段行内代码,可以用反引号把它包起来(`),示例如下:

github中`README.md`文件的编写

标记代码段需要使用三个反引号包围代码段,前面三个反引号后紧跟代码所使用语言可使代码高亮

9.表格

极简方式

|  calss | age |
| ------------ | ------------ |
| 1 | 18 |
| 2 | 20 |
calss age
1 18
2 20

居中对齐

|  class | age  |
| :------------: | :------------: |
| 1 | 18 |
| 2 | 20 |
class age
1 18
2 20

左对齐

|  class | age  |
| :------------ | :------------ |
| 1 | 18 |
| 2 | 20 |
class age
1 18
2 20

右对齐

|  class | age  |
| ------------: | ------------: |
| 1 | 18 |
| 2 | 20 |
class age
1 18
2 20

-:表示内容和标题栏居右对齐
:-表示内容和标题栏居左对齐
:-:表示内容和标题栏居中对齐。
内容和|之间的多余空格会被忽略,每行第一个|和最后一个|可以省略,-的数量至少有一个。

常用的应该就这些了~~~

发表评论

您的电子邮箱地址不会被公开。 必填项已用*标注