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
66. 66
67. 67
68. 68
69. 69
70. 70
71. 71
72. 72
73. 73
74. 74
75. 75
76. 76
77. 77
78. 78
79. 79
80. 80
81. 81
82. 82
83. 83
84. 84
85. 85
86. 86
87. 87
88. 88
89. 89
90. 90
91. 91
92. 92
93. 93
94. 94
95. 95
96. 96
97. 97
98. 98
99. 99
100. 100
101. 101
102. 102
103. 103
104. 104
105. 105
106. 106
107. 107
108. 108
109. 109
110. 110
111. 111
112. 112
113. 113
114. 114
115. 115
116. 116
117. 117
118. 118
119. 119
120. 120
121. 121
122. 122
123. 123
124. 124
125. 125
126. 126
127. 127
128. 128
129. 129
130. 130
131. 131
132. 132
133. 133
134. 134
135. 135
136. 136
137. 137
138. 138
139. 139
140. 140
141. 141
142. 142
143. 143
144. 144
145. 145
146. 146
147. 147
148. 148
149. 149
150. 150
151. 151
152. 152
153. 153
154. 154
155. 155
156. 156
157. 157
158. 158
159. 159
160. 160
161. 161
162. 162
163. 163
164. 164
165. 165
166. 166
167. 167
168. 168
169. 169
170. 170
171. 171
172. 172
173. 173
174. 174
175. 175
176. 176
177. 177
178. 178
179. 179
180. 180
181. 181
182. 182

## Input options

### `input.path`

- Type: `string` (file path)
- CLI: First positional argument
- Required

Path to a Vault (source directory includes documents).
Path needs to be relative and resolved from the config file.

## Output options

### `output.path`

- Type: `string` (file path)
- CLI: `--out <PATH>` option
- Required

Path to the output directory.
Path needs to be relative and resolved from the config file.

### `output.baseURL`

- Type: `string` (URL or path)
- CLI: `--base-url <URL OR PATH>` option
- Example: `"/foo/"`, `"https://example.com/"`

Base URL for the generated website.

Path part needs to end with trailing slash: otherwise the last segment will be omitted.
For example, link for the `Foo.md` under `--base-url /bar/baz` will look like `/bar/Foo/`.

### `output.userCSS`

- Type: `string` (file path)
- CLI: `--user-css <PATH>` option

Path to the user provided CSS file.
Path needs to be relative and inside the vault, and will be resolved from the config file.

Assets referenced in the CSS file are automatically included in the final output, such as font file.
Referenced assets needs to be relative and inside the vault too.

### `output.notFoundPage.enabled`

- Type: `boolean`
- Default: `true` if `output.baseURL` is full URL or absolute path, otherwise `false`

Enable generation of Not Found page.

### `output.notFoundPage.filename`

- Type: `string` (file name)
- CLI: `--not-found-filename <FILENAME>` option
- Default: `404.html`

Filename of generated Not Found page.

### `output.precompress`

- Type: `boolean`
- CLI: `--precompress` flag

Whether to compress `.html`, `.css` and `.js` files into `.<ext>.gz`, `.<ext>.br` and `.<ext>.zst` files.
For example, if an output directory contains `index.html`, Macana also generates
- `index.html.gz` (Gzip)
- `index.html.br` (Brotli)
- `index.html.zst` (ZStandard)

inside the same directory.

## Website metadata options

### `metadata.name`

- Type: `string`
- CLI: `--name <TEXT>` option
- Required

Website name, title.
`<title>` and a title section in a header uses this text.

### `metadata.favicon.svg`

- Type: `string` (file path)
- CLI: `--favicon-svg <PATH>` option

Path to a SVG file to use as a favicon.
Path needs to be relative and resolved from the config file.

### `metadata.favicon.png`

- Type: `string` (file path)
- CLI: `--favicon-png <PATH>` option

Path to a PNG file to use as a favicon.
Path needs to be relative and resolved from the config file.

### `metadata.copyright`

- Type: `string`
- CLI: `--copyright <TEXT>` option
- Required

Copyright text to show in the generated website.

### `metadata.logoImage`

- Type: `string` (file path)
- CLI: `--logo-image <PATH>` option

Path to an image file to use as a website logo.
Path needs to be relative and resolved from the config file.

### `metadata.openGraph.image`

- Type: `string` (file path)
- CLI: `--og-image <PATH>` option

Path to an image file to use as an [Open Graph](https://ogp.me/) image (`og:image`).
Path needs to be relative and resolved from the config file.

Macana sets Open Graph attributes only when the value of [[#`output.baseURL`]] is full URL string.
Path only strings and such are not considered as Open Graph ready base URL.

## Document options
### `documents.defaultLanguage`

- Type: `string`
- CLI: `--lang <TEXT>` option
- Default: `"en"`

Default language for the generated website.

### `documents.languages.<directory>`

- Type: `{ title: string; lang: string }`

If a directory name matches to `<directory>`, the directory is treated as a language directory: the directory itself and its contents have different language than the parent one.

### `documents.resolveShortestPathWhenPossible`

- Type: `boolean`
- CLI: `--shortest-path-when-possible` flag

Enable support for Obsidian's "[[Ambiguous path resolution#Shortest path when possible|Shortest path when possible]]" link resolution.

### `documents.title.keepExtension`

- Type: `boolean`
- CLI: `--keep-ext` flag

By default, Macana use filename without file extension part as a document title.
If this option is enabled, Macana does not trim the file extension part.

## Markdown options

### `markdown.enabled`

- Type: `boolean`
- Default: `true`

Enable parsing of Markdown documents.
You can disable this from CLI via `--disable-markdown` flag.

### `markdown.yamlFrontmatter`

- Type: `boolean`
- CLI: `--markdown-frontmatter` flag

Enable parsing of YAML frontmatter in Markdown documents.

## JSONCanvas options

### `jsonCanvas.enabled`

- Type: `boolean`
- Default: `true`

Enable parsing of JSONCanvas documents.
You can disable this from CLI via `--disable-jsoncanvas` flag.