MarkDown 语法笔记

这是一篇完全不会.md的同学的笔记

引言

记得我第一次访问github网站的时候,摸索着学习怎么创建仓库。然后我发现自动创建的仓库下有一个文件叫

Readme.md

我感到很奇怪,因为以前只看到过readme.txt,这个md是何方神圣?
既然文件名叫Readme,那想必是文本文件可以直接用记事本读取。
后来我了解到了MarkDowen这个东西。

介绍

传统的readme.txt文件是单纯的文本格式,任何系统都可以轻松打开,经过仔细排版以后可以很容易阅读里面的内容。
但是如果把这个txt文件放到网页上显示,效果就没那么美好了。或者说,我们需要更好的网页显示效果。
于是就诞生了markdown格式。发明者运用了标记语言的方法,让解析器解析出标记以后用特定的显示格式来显示
就好像是用html语言排版过一样。对于文科生,这样可能有些不好理解,但是对于程序员,这都不是事儿。

需要做的事情

找一个MarkDown编辑器,编辑,放到支持的地方,就可以显示了。现在很多博客站特别是程序员博客站支持显示标记过的文本。
比如github, csdn等,有一些普通博客站也支持。

很多开源项目会放到github上,主页下面就显示了排版很清晰的Readme.md文件内容。

言归正传

下面介绍我自己知道的关于怎么用.md的标记来排版。

标题

方法1:换一行,标记----或者====,任意多个都可以,这个标记的上一样就会显示为标题

这是标题
======
这也是标题
------

这是标题

这也是标题

方法2:在开头标记#,标记1个-6个对应HTML里面的<h1>-<h6>

#标题1
###标题3
######标题6

标题1

标题3

标题6

我发现这个标题6好像跟正文差不多

引用内容

在文本前面加上>就可以了

>这是引用内容
这也是另一行引用内容

这是引用内容
这也是另一样引用内容

只需要在第一行标记>就可以,如果要退出引用段落,需要空一行

段落内标记
  1. 粗体,用**或者__包含内容
  2. 斜体,用*或者_包含内容
  3. 又粗体又斜体?当然是***或者___了!
  4. 代码段,用 ` 来包含

斜体
粗体
粗体+斜体
行内代码段

表格

这个我还没用过,基本原理差不多,代码如下所示

| 项目           | 收入           | 记录员  |
| ------------- |:-------------:| -----: |
| 建筑          | 5000           | septem |
| 材料          | 1500           |  nico  |
| 人工          | 600            |  hero  |

这里冒号表示对齐的方向,冒号在哪就向哪里对齐,前后都有就中间对齐。
记得要用英文符号

项目收入记录员
建筑5000septem
材料1500nico
人工600hero
代码段

方法1 :独立的代码段,只需要在空一行以后,输入4个空格或者一个制表符就可以

function testFunc() {
    return "nothing";
}

效果就是这样

方法2: 第一行,开头3个反引号
然后输入语言的名字,最后一样,开头3个反引号

```java
public class MyClass {
    public Myclass {
    //this is construct method.
    }
    public static boolean show(String msg) {
        System.out.println(msg);
        return true;
    }
}
```
public class MyClass {
        public Myclass {
        //this is construct method.
        }
        public static boolean show(String msg) {
            System.out.println(msg);
            return true;
        }
    }

这样标记了一个可以语法高亮的代码段,效果嘛,总比没有强而已。

分割线

单独的一样输入3个* :
***
效果就这样


好像很淡

链接

方法1: 要在文章中加入链接,就用方括号[]标记,然后再后面紧接着用圆括号()表示URL

[SOHU](http://www.sohu.com)

sohu

方法2:如果不希望在文章中标记URL,可以用以下的方式

[NAME]
在之后的任意地方标记:
[NAME]:URL   "提示"

这样就可以标记处一个链接,例如

[steam]
[steam]:http://store.steampowered.com   "STEAM"

效果如下:
steam
这样做的好处是,如果有多个相同的链接,就不用重复输入URL了

(还有其他标记链接的方式)

总结

还有一些标记方式我没有写下来。
我写这篇笔记的就用的CSDN的MarkDown编辑器,上面就有完整的语法提示。
其实看我这个还不如直接看那个更专业更简明的提示。

我觉得记笔记这个方式很好,即便过后再也没看过,也能加强记忆。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值