blob: 10956382bfdf418a9a5c58c318f4b3d437a4ef97 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
|
---
robots: index, follow
lang: en
dir: ltr
breaks: true
---
# Supported YAML metadata
First you need to insert syntax like this at the **start** of the note:
```yaml
---
YAML metas
---
```
Replace the "YAML metas" in this section with any YAML options as below.
You can also refer to this note's source code.
## title
This option will set the note title which prior than content title.
> default: not set
**Example**
```yml
title: meta title
```
## description
This option will set the note description as a `<meta name="description">` tag. This only affects the [Publish](../features#Share-Notes) function.
> default: not set
**Example**
```yml
description: meta description
```
## tags
This option will set the tags which prior than content tags.
> default: not set
**Example**
```yml
tags: features, cool, updated
```
## robots
This option will give below meta in the note head meta:
```xml
<meta name="robots" content="your_meta">
```
So you can prevent any search engine index your note by set `noindex, nofollow`.
> default: not set
**Example**
```yml
robots: noindex, nofollow
```
## lang
This option will set the language of the note.
Setting the language helps the browser to apply rules such as typography correctly.
You can find your the language code in ISO 639-1 standard:
<https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes>
> default: not set (which will be en)
**Example**
```yml
lang: ja-jp
```
## dir
This option specifies the direction of the text in this note.
You can only use whether `rtl` or `ltr`.
Look more at here:
<http://www.w3.org/International/questions/qa-html-dir>
> default: not set (which will be ltr)
**Example**
```yml
dir: rtl
```
## breaks
This option means the hardbreaks in the note will be parsed or be ignore.
The original markdown syntax breaks only if you put space twice, but CodiMD choose to breaks every time you enter a break.
You can only use whether `true` or `false`.
> default: not set (which will be true)
**Example**
```yml
breaks: false
```
## GA
This option allows you to enable Google Analytics with your ID.
> default: not set (which won't enable)
**Example**
```yml
GA: UA-12345667-8
```
## disqus
This option allows you to enable Disqus with your shortname.
> default: not set (which won't enable)
**Example**
```yml
disqus: codimd
```
## type
This option allows you to switch the document view to the slide preview, to simplify live editing of presentations.
> default: not set
**Example:**
```yml
type: slide
```
## slideOptions
This option allows you to provide custom options to slide mode.
Please below document for more details:
<https://github.com/hakimel/reveal.js/#configuration>
You could also set slide theme which named in below css files:
<https://github.com/hakimel/reveal.js/tree/master/css/theme>
**Notice: always use two spaces as indention in YAML metadata!**
> default: not set (which use default slide options)
**Example**
```yml
slideOptions:
transition: fade
theme: white
```
## opengraph
This option allows you to override the default generated opengraph metadata.
See the [OpenGraph protocol documentation](https://ogp.me) for more information.
**Notice: always use two spaces as indention in YAML metadata!**
> default: not set (uses auto-generated metadata)
**Example**
```yml
opengraph:
title: Special title for OpenGraph protocol
image: https://dummyimage.com/600x600/000/fff
image:type: image/png
```
|
