Skip to content

Commit 4302128

Browse files
committed
Some minor improvements to the yaml-metadata docs
Switching form XAML to YAML syntax highlighting and fixing some grammar. Signed-off-by: Sheogorath <[email protected]>
1 parent 3020c11 commit 4302128

File tree

1 file changed

+15
-15
lines changed

1 file changed

+15
-15
lines changed

public/docs/yaml-metadata.md

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ This option will set the note title which prior than content title.
2525
> default: not set
2626
2727
**Example**
28-
```xml
28+
```yml
2929
title: meta title
3030
```
3131
@@ -36,7 +36,7 @@ This option will set the note description.
3636
> default: not set
3737
3838
**Example**
39-
```xml
39+
```yml
4040
description: meta description
4141
```
4242
@@ -47,7 +47,7 @@ This option will set the tags which prior than content tags.
4747
> default: not set
4848
4949
**Example**
50-
```xml
50+
```yml
5151
tags: features, cool, updated
5252
```
5353
@@ -62,7 +62,7 @@ So you can prevent any search engine index your note by set `noindex, nofollow`.
6262
> default: not set
6363
6464
**Example**
65-
```xml
65+
```yml
6666
robots: noindex, nofollow
6767
```
6868
@@ -75,21 +75,21 @@ https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes
7575
> default: not set (which will be en)
7676
7777
**Example**
78-
```xml
78+
```yml
7979
langs: ja-jp
8080
```
8181
8282
dir
8383
---
84-
This option provide to describe the direction of the text in this note.
84+
This option specifies the direction of the text in this note.
8585
You can only use whether `rtl` or `ltr`.
8686
Look more at here:
8787
http://www.w3.org/International/questions/qa-html-dir
8888

8989
> default: not set (which will be ltr)
9090

9191
**Example**
92-
```xml
92+
```yml
9393
dir: rtl
9494
```
9595

@@ -102,29 +102,29 @@ You can only use whether `true` or `false`.
102102
> default: not set (which will be true)
103103

104104
**Example**
105-
```xml
105+
```yml
106106
breaks: false
107107
```
108108

109109
GA
110110
---
111-
This option allow you to enable Google Analytics with your ID.
111+
This option allows you to enable Google Analytics with your ID.
112112

113113
> default: not set (which won't enable)
114114

115115
**Example**
116-
```xml
116+
```yml
117117
GA: UA-12345667-8
118118
```
119119

120120
disqus
121121
---
122-
This option allow you to enable Disqus with your shortname.
122+
This option allows you to enable Disqus with your shortname.
123123

124124
> default: not set (which won't enable)
125125

126126
**Example**
127-
```xml
127+
```yml
128128
disqus: codimd
129129
```
130130

@@ -135,13 +135,13 @@ This option allows you to switch the document view to the slide preview, to simp
135135
> default: not set
136136

137137
**Example:**
138-
```xml
138+
```yml
139139
type: slide
140140
```
141141

142142
slideOptions
143143
---
144-
This option allow you provide custom options to slide mode.
144+
This option allows you to provide custom options to slide mode.
145145
Please below document for more details:
146146
https://github.com/hakimel/reveal.js/#configuration
147147

@@ -153,7 +153,7 @@ https://github.com/hakimel/reveal.js/tree/master/css/theme
153153
> default: not set (which use default slide options)
154154

155155
**Example**
156-
```xml
156+
```yml
157157
slideOptions:
158158
transition: fade
159159
theme: white

0 commit comments

Comments
 (0)