1. 1
2. 2
3. 3
4. 4
5. 5
6. 6
7. 7
8. 8
9. 9
10. 10
11. 11
12. 12
13. 13
14. 14
15. 15
16. 16
17. 17
18. 18
19. 19
20. 20
21. 21
22. 22
23. 23
24. 24
25. 25
26. 26
27. 27
28. 28
29. 29
30. 30
31. 31
32. 32
33. 33
34. 34
35. 35
36. 36
37. 37
38. 38
39. 39
40. 40
41. 41
42. 42
43. 43
44. 44
45. 45
46. 46
47. 47
48. 48
49. 49
50. 50
51. 51
52. 52
53. 53
54. 54
55. 55
56. 56
57. 57
58. 58
59. 59
60. 60
61. 61
62. 62
63. 63
64. 64
65. 65

This page lists supported YAML frontmatter fields.
## `name`

- Type: `string`

Name of the document.
This appears the final URL path and affects links.

For example, if a file named `/Foo.md` has below frontmatter,

```markdown
---
name: "Bar"
---

# Baz
```

the final URL would be like `http://localhost:8080/Bar/`.
You should avoid reaching to this field.

## `title`

- Type: `string`

Title of the document.
By default, file name is used as a title.

## `description`

- Type: `description`

Description text of the document.

## `lang`

- Type: `string`
- Alias: `language`
- Example: `en-US`, `ja`, `zh-Hans`

Language of the document.
This field value goes to HTML's `lang` tag, hence you should use language tag adheres to [RFC 5646 - Tags for Identifying Languages](https://datatracker.ietf.org/doc/html/rfc5646).

## `createdAt`

- Type: `string` (datetime)
- Example: `2020-01-01T08:30:00+05:00`

Creation time of the document.
While you can use various date time format for this field, you should stick to [Date Time String Format defined in ECMAScript](https://tc39.es/ecma262/multipage/numbers-and-dates.html#sec-date-time-string-format) (`YYYY-MM-DDTHH:mm:ss.sssZ`).

## `updatedAt`

- Type: `string` (datetime)
- Example: `2020-01-01T08:30:00+05:00`

Update time of the document.
While you can use various date time format for this field, you should stick to [Date Time String Format defined in ECMAScript](https://tc39.es/ecma262/multipage/numbers-and-dates.html#sec-date-time-string-format) (`YYYY-MM-DDTHH:mm:ss.sssZ`).

## `defaultDocument`

- Type: `boolean`

Whether this document is the default document of a generated website.
If more than one documents have this field set on, behavior is undefined.