是不是总在各大项目中看见一个README.md的文件却不知道它是什么意思呢,本篇文章不仅会对这种以.md为后缀的文件进行解释,也会提出一些基本用法。
本文使用MarkDown语言编写
学习总是要经过完整的逻辑思维过程
- 是什么
- 为什么
- 怎么做
本篇文章的MarkDown语法快速入门就围绕着这三点
一.MarkDown是什么
Markdown是一种轻量级标记语言,创始人为约翰·格鲁伯(英语:John Gruber)。 它允许人们使用易读易写的纯文本格式编写文档,然后转换成有效的XHTML(或者HTML)文档。
由于Markdown的轻量化、易读易写特性,并且对于图片,图表、数学式都有支持,许多网站都广泛使用Markdown来撰写帮助文档或是用于论坛上发表消息。如GitHub、Reddit、Diaspora、Stack Exchange、OpenStreetMap 、SourceForge、简书等,甚至还能被使用来撰写电子书。1
二.为什么要学习MarkDown语法
这个语言起初的目的是希望大家使用“易于阅读、易于撰写的纯文字格式,并选择性的转换成有效的XHTML(或是HTML)。
现在MarkDown语法不仅仅是用来编写README.md,用来帮助公众号排版,更加使人舒适的是,它能很好的做到内容与样式的分离,在不同平台间共享与阅读。
三.怎么编写MarkDown的文本
标题
1.几个#就表示几级标题;
段落格式
2.换行使用两个以上空格加回车或者两段内容间加一个空行;
3.字体类型
(使用*或者_包围两侧)
斜体文本
斜体文本
(使用**或者__包围两侧)
粗体文本
粗体文本
(使用***或者___包围两侧)
粗斜体文本
粗斜体文本
4.分割线
三个以上的星号、减号、底线建立,行内不允许有其他内容。
5.删除线
在要删除内容的两端加上波浪线~~
删除内容
6.下划线
使用HTML的(u)内容(/u)
标注内容
7.脚注(对文本的补充)
格式:[^要注明的文本]
创建脚注格式类似这样 名言2。
列表
8.无序列表
使用*号、+号或-号作为列表标记,在这些标记后加上一个空格,在填写内容。
- 第一项
- 第二项
- 第三项
9.有序列表
使用数字加上 . 和一个空格表示
- 第一项
- 第二项
- 第三项
10.列表嵌套
只需在子列表中的选项前面添加四个空格即可
- 第一项
- number1
- number2
- 第二项
- number3
- number4
区块
11.区块引用
在段落开头使用>号和一个空格
这是一个区块
12.区块嵌套
使用几个>就是第几层嵌套
第一层嵌套
第二层嵌套
第三层嵌套
13.区块中使用列表
- 第一列
- 第二列
14.列表中使用区块
- 第一项
- 第一行
- 第二行
- 第二项
- 第一行
- 第二行
代码
15.段落或者片段上的代码
使用 ` 将其包起来
printf()
16.代码区块
-
使用制表符或者4个空格
public class HelloWorld { public static void main(String[] args) { System.out.println("Hello World!"); } }
-
使用```来包裹代码并可在符号后面指定语言
public class HelloWorld {
public static void main(String[] args) {
System.out.println("Hello World!");
}
}
链接
17.链接地址
[链接名称](链接地址)或者 [链接名称]<链接地址>
本章学习内容来自链接菜鸟教程
18.直接链接
使用<>包裹网址
https://www.runoob.com/markdown/md-tutorial.html
19.高级链接
使用变量用[]包裹起来,变量赋值在文末
这个链接用1作为网址变量
菜鸟教程
图片
20.图片本身也是一种链接
在链接样式前加!
![picture](链接)
21.图片(高级链接法)(不够直观)
这个图片用2作为网址变量
picture
22.调整格式
用HTML的img标签
<img src="picture.png" width=50%>
表格
23.制作表格
使用|来分隔不同单元格,使用-来分隔表头与其他行
表头 | 表头 |
---|---|
单元格 | 单元格 |
单元格 | 单元格 |
24.对齐方式(在分割表头与其他行那行来写)
右对齐:-:
左对齐::-
居中对齐: :-:
高级技巧
- 支持HTML元素
不在 Markdown 涵盖范围之内的标签,都可以直接在文档里面用 HTML 撰写。 - 用 \ 转义特殊字符
* 、<u> 等 - Markdown Preview Enhanced 使用 KaTeX3 或者 MathJax4 来渲染数学表达式。
- Mardown还支持一些可爱的小表情链接
四.常用编译器推荐
我只推荐我觉着好用的
免费的可以用Visual Studio Code;
附:下载地址https://code.visualstudio.com/
付费的使用Typora
附:下载地址https://typoraio.cn/
第一节MarkDown定义摘录自百度百科,链接https://baike.baidu.com/item/markdown/3245829。 ↩︎
我感受到的压力,都是来自于我自己不努力不积极又不甘于现状的恐慌。 ↩︎
数学公式引擎,可汗学院开发,js库,链接https://katex.org/。 ↩︎
数学公式渲染器,js编写,链接https://www.mathjax.org/。 ↩︎