前言
我们在使用VuePress书写文档的时候,我们会接触到YAML,进行小编就带大家一起认识下YAML,同时也带大家认识下VuePress中的YAML Front Matter。
什么是YAML
YAML(YAML Ain`t Markup language)文件,它不是一个标记语言,以前我们的配置文件都是xml、properties, ,但YAML是以数据为中心,更适合做配置文件
YAML 的语法和其他高级语言类似,并且可以简单表达清单、散列表,标量等数据形态。它使用空白符号缩进和大量依赖外观的特色,特别适合用来表达或编辑数据结构、各种配置文件、倾印调试内容、文件大纲(例如:许多电子邮件标题格式和YAML非常接近)。
YAML 的配置文件后缀为 .yml,如:application.yml
基本语法
- 大小写敏感
- 使用缩进表示层级关系
- 缩进不允许使用tab建,只能使用空格键
- 缩进空格数目不重要,只要相同层级的元素左对齐即可
- '#'表示注释
数据类型
YAML 支持以下几种数据类型:
- 常量
- 对象和MAP
- 数组
- 复合结构
- 特殊符号
常量
纯量是最基本的,不可再分的值,包括:
- 字符串
- 布尔值
- 整数
- 浮点数
- Null
- 时间
- 日期
示例:
boolean: - TRUE #true,True都可以 - FALSE #false,False都可以 float: - 3.14 - 6.8523015e+5 #可以使用科学计数法 int: - 123 - 0b1010_0111_0100_1010_1110 #二进制表示 null: nodeName: 'node' parent: ~ #使用~表示null string: - 快智岛 - 'Hello world' #可以使用双引号或者单引号包裹特殊字符 - newline newline2 #字符串可以拆成多行,每一行会被转化成一个空格 date: - 2021-06-26 #日期必须使用ISO 8601格式,即yyyy-MM-dd datetime: - 2018-02-17T15:02:31+08:00 #时间使用ISO 8601格式,时间和日期之间使用T连接,最后使用+代表时区
YAML 对象
对象键值对使用冒号结构表示 key: value,冒号后面要加一个空格。
也可以使用 key:{key1: value1, key2: value2, ...}。
还可以使用缩进表示层级关系;
key: child-key1: value1 child-key2: value2
YAML中还支持流式(flow)语法表示对象,比如上面例子可写为:
key:{child-key1: value1,child-key2: value2}
较为复杂的对象格式,可以使用问号加一个空格代表一个复杂的 key,配合一个冒号加一个空格代表一个 value:
? - complexkey1 - complexkey2 : - complexvalue1 - complexvalue2
意思即对象的属性是一个数组 [complexkey1,complexkey2]
,对应的值也是一个数组 [complexvalue1,complexvalue2]
使用流式语法即为[complexkey1,complexkey2]:[complexvalue1,complexvalue2]
- MAP使用键值对
#普通写法 name: kuaizhidao age: 12 #行内写法 `{name: kuaizhidao`,age: 12}
YAML 数组
以 - 开头的行表示构成一个数组:
key: - A - B - C
YAML 支持多维数组,可以使用行内表示:
key: [A, B,C]
数据结构的子成员是一个数组,则可以在该项下面缩进一个空格。
- - A - B - C
YAML 支持多维数组,可以使用行内表示:
[[A, B,C]]
一个相对复杂的例子:
companies: - id: 1 name: company1 price: 200W - id: 2 name: company2 price: 500W
意思是 companies 属性是一个数组,每一个数组元素又是由 id、name、price 三个属性构成。
数组也可以使用流式(flow)的方式表示:
companies: [ {id: 1,name: companyA,price: 1200W}, {id: 2,name: companyB,price: 1500W} ]
复合结构
数组和对象可以构成复合结构
languages: - Ruby - Perl - Python websites: YAML: yaml.org Ruby: ruby-lang.org Python: python.org Perl: use.perl.org
转换为 json 为:
{ languages: [ 'Ruby', 'Perl', 'Python'], websites: { YAML: 'yaml.org', Ruby: 'ruby-lang.org', Python: 'python.org', Perl: 'use.perl.org' } }
特殊符号
- --- yaml可以在同一个文件中,使用---表示一个文档的开始:
- ...和---配合使用,在一个配置文件中代表一个文件的结束
- !!yaml中使用!!做类型强行转换
在字符串中折叠换行, |保留换行,这两个符号是yaml中字符串经常使用的符号
- 用重复的内容在yaml中可以使用&符号来完成锚点定义,使用*来完成锚点引用
- 合并内容。主要和锚点配合使用,可以将一个锚点内容直接合并到一个对象中
引用
& 锚点和 * 别名,可以用来引用:
defaults: &defaults adapter: postgres host: localhost development: database: myapp_development <<: *defaults test: database: myapp_test <<: *defaults 相当于: defaults: adapter: postgres host: localhost development: database: myapp_development adapter: postgres host: localhost test: database: myapp_test adapter: postgres host: localhost
& 用来建立锚点(defaults),<< 表示合并到当前数据,* 用来引用锚点。
下面是另一个例子:
- &showell Steve - Clark - Brian - Oren - *showell
转为 JavaScript 代码如下:
[ 'Steve', 'Clark', 'Brian', 'Oren', 'Steve' ]