You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/index/interfaces/DocxOptions.md
+39-39Lines changed: 39 additions & 39 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@
4
4
5
5
# Interface: DocxOptions
6
6
7
-
Defined in: [src/mdast-util-to-docx.ts:188](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/mdast-util-to-docx.ts#L188)
7
+
Defined in: [src/mdast-util-to-docx.ts:188](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/mdast-util-to-docx.ts#L188)
8
8
9
9
## Extends
10
10
@@ -14,19 +14,19 @@ Defined in: [src/mdast-util-to-docx.ts:188](https://github.com/inokawa/remark-do
14
14
15
15
### size?
16
16
17
-
> `optional`**size**: `object`
17
+
> `optional`**size?**: `object`
18
18
19
-
Defined in: [src/mdast-util-to-docx.ts:202](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/mdast-util-to-docx.ts#L202)
19
+
Defined in: [src/mdast-util-to-docx.ts:202](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/mdast-util-to-docx.ts#L202)
20
20
21
21
Page size defined in twip (1 twip == 1/1440 inch).
22
22
23
23
#### width?
24
24
25
-
> `optional`**width**: `number`
25
+
> `optional`**width?**: `number`
26
26
27
27
#### height?
28
28
29
-
> `optional`**height**: `number`
29
+
> `optional`**height?**: `number`
30
30
31
31
#### Default
32
32
@@ -36,27 +36,27 @@ A4 (sectionPageSizeDefaults)
36
36
37
37
### margin?
38
38
39
-
> `optional`**margin**: `object`
39
+
> `optional`**margin?**: `object`
40
40
41
-
Defined in: [src/mdast-util-to-docx.ts:207](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/mdast-util-to-docx.ts#L207)
41
+
Defined in: [src/mdast-util-to-docx.ts:207](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/mdast-util-to-docx.ts#L207)
42
42
43
43
Page margin defined in twip (1 twip == 1/1440 inch).
44
44
45
45
#### top?
46
46
47
-
> `optional`**top**: `number`
47
+
> `optional`**top?**: `number`
48
48
49
49
#### left?
50
50
51
-
> `optional`**left**: `number`
51
+
> `optional`**left?**: `number`
52
52
53
53
#### bottom?
54
54
55
-
> `optional`**bottom**: `number`
55
+
> `optional`**bottom?**: `number`
56
56
57
57
#### right?
58
58
59
-
> `optional`**right**: `number`
59
+
> `optional`**right?**: `number`
60
60
61
61
#### Default
62
62
@@ -66,9 +66,9 @@ Page margin defined in twip (1 twip == 1/1440 inch).
Defined in: [src/mdast-util-to-docx.ts:212](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/mdast-util-to-docx.ts#L212)
71
+
Defined in: [src/mdast-util-to-docx.ts:212](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/mdast-util-to-docx.ts#L212)
72
72
73
73
Page orientation.
74
74
@@ -82,9 +82,9 @@ Page orientation.
82
82
83
83
### columns?
84
84
85
-
> `optional`**columns**: `number`
85
+
> `optional`**columns?**: `number`
86
86
87
-
Defined in: [src/mdast-util-to-docx.ts:217](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/mdast-util-to-docx.ts#L217)
87
+
Defined in: [src/mdast-util-to-docx.ts:217](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/mdast-util-to-docx.ts#L217)
88
88
89
89
Number of page columns.
90
90
@@ -98,9 +98,9 @@ Number of page columns.
98
98
99
99
### spacing?
100
100
101
-
> `optional`**spacing**: `number`
101
+
> `optional`**spacing?**: `number`
102
102
103
-
Defined in: [src/mdast-util-to-docx.ts:222](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/mdast-util-to-docx.ts#L222)
103
+
Defined in: [src/mdast-util-to-docx.ts:222](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/mdast-util-to-docx.ts#L222)
104
104
105
105
Spacing after Paragraphs in twip (1 twip == 1/1440 inch).
106
106
@@ -114,9 +114,9 @@ Spacing after Paragraphs in twip (1 twip == 1/1440 inch).
Defined in: [src/mdast-util-to-docx.ts:227](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/mdast-util-to-docx.ts#L227)
119
+
Defined in: [src/mdast-util-to-docx.ts:227](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/mdast-util-to-docx.ts#L227)
Defined in: [src/mdast-util-to-docx.ts:232](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/mdast-util-to-docx.ts#L232)
135
+
Defined in: [src/mdast-util-to-docx.ts:232](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/mdast-util-to-docx.ts#L232)
136
136
137
137
An option to override the text format of ordered list.
138
138
See https://docx.js.org/#/usage/numbering?id=level-options for more details.
@@ -141,9 +141,9 @@ See https://docx.js.org/#/usage/numbering?id=level-options for more details.
Defined in: [src/mdast-util-to-docx.ts:241](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/mdast-util-to-docx.ts#L241)
146
+
Defined in: [src/mdast-util-to-docx.ts:241](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/mdast-util-to-docx.ts#L241)
147
147
148
148
An option to select how thematicBreak works.
149
149
@@ -161,19 +161,19 @@ An option to select how thematicBreak works.
Defined in: [src/mdast-util-to-docx.ts:245](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/mdast-util-to-docx.ts#L245)
166
+
Defined in: [src/mdast-util-to-docx.ts:245](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/mdast-util-to-docx.ts#L245)
167
167
168
168
Plugins to customize how mdast nodes are compiled.
169
169
170
170
***
171
171
172
172
### title?
173
173
174
-
> `readonly``optional`**title**: `string`
174
+
> `readonly``optional`**title?**: `string`
175
175
176
-
Defined in: node\_modules/docx/dist/index.d.ts:1415
176
+
Defined in: node\_modules/docx/dist/index.d.ts:1569
177
177
178
178
#### Inherited from
179
179
@@ -183,9 +183,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1415
183
183
184
184
### subject?
185
185
186
-
> `readonly``optional`**subject**: `string`
186
+
> `readonly``optional`**subject?**: `string`
187
187
188
-
Defined in: node\_modules/docx/dist/index.d.ts:1416
188
+
Defined in: node\_modules/docx/dist/index.d.ts:1570
189
189
190
190
#### Inherited from
191
191
@@ -195,9 +195,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1416
195
195
196
196
### creator?
197
197
198
-
> `readonly``optional`**creator**: `string`
198
+
> `readonly``optional`**creator?**: `string`
199
199
200
-
Defined in: node\_modules/docx/dist/index.d.ts:1417
200
+
Defined in: node\_modules/docx/dist/index.d.ts:1571
201
201
202
202
#### Inherited from
203
203
@@ -207,9 +207,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1417
207
207
208
208
### keywords?
209
209
210
-
> `readonly``optional`**keywords**: `string`
210
+
> `readonly``optional`**keywords?**: `string`
211
211
212
-
Defined in: node\_modules/docx/dist/index.d.ts:1418
212
+
Defined in: node\_modules/docx/dist/index.d.ts:1572
213
213
214
214
#### Inherited from
215
215
@@ -219,9 +219,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1418
219
219
220
220
### description?
221
221
222
-
> `readonly``optional`**description**: `string`
222
+
> `readonly``optional`**description?**: `string`
223
223
224
-
Defined in: node\_modules/docx/dist/index.d.ts:1419
224
+
Defined in: node\_modules/docx/dist/index.d.ts:1573
225
225
226
226
#### Inherited from
227
227
@@ -231,9 +231,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1419
Defined in: [src/plugins/html/index.ts:9](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugins/html/index.ts#L9)
9
+
Defined in: [src/plugins/html/index.ts:9](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugins/html/index.ts#L9)
Defined in: [src/plugins/image/index.ts:72](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugins/image/index.ts#L72)
9
+
Defined in: [src/plugins/image/index.ts:72](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugins/image/index.ts#L72)
Copy file name to clipboardExpand all lines: docs/plugins/image/interfaces/ImagePluginOptions.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,15 +4,15 @@
4
4
5
5
# Interface: ImagePluginOptions
6
6
7
-
Defined in: [src/plugins/image/index.ts:56](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugins/image/index.ts#L56)
7
+
Defined in: [src/plugins/image/index.ts:56](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugins/image/index.ts#L56)
8
8
9
9
## Properties
10
10
11
11
### load?
12
12
13
-
> `optional`**load**: `LoadFn`
13
+
> `optional`**load?**: `LoadFn`
14
14
15
-
Defined in: [src/plugins/image/index.ts:61](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugins/image/index.ts#L61)
15
+
Defined in: [src/plugins/image/index.ts:61](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugins/image/index.ts#L61)
16
16
17
17
A function to resolve image data from url.
18
18
@@ -24,9 +24,9 @@ loadWithFetch
24
24
25
25
### fallbackSvg?
26
26
27
-
> `optional`**fallbackSvg**: `SvgToPngFn`
27
+
> `optional`**fallbackSvg?**: `SvgToPngFn`
28
28
29
-
Defined in: [src/plugins/image/index.ts:66](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugins/image/index.ts#L66)
29
+
Defined in: [src/plugins/image/index.ts:66](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugins/image/index.ts#L66)
30
30
31
31
A function to convert SVG to PNG. According to the docx specifications, embedding SVG images also requires including PNG.
Defined in: [src/plugins/latex/index.ts:95](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugins/latex/index.ts#L95)
9
+
Defined in: [src/plugins/latex/index.ts:95](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugins/latex/index.ts#L95)
10
10
11
11
A plugin to render LaTeX inside "math" and "inlineMath" nodes
Defined in: [src/plugins/mermaid/index.ts:24](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugins/mermaid/index.ts#L24)
9
+
Defined in: [src/plugins/mermaid/index.ts:24](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugins/mermaid/index.ts#L24)
10
10
11
11
A plugin to render Mermaid inside "code" nodes with "mermaid" language.
Defined in: [src/plugins/shiki/index.ts:40](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugins/shiki/index.ts#L40)
9
+
Defined in: [src/plugins/shiki/index.ts:40](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugins/shiki/index.ts#L40)
10
10
11
11
A plugin to render "code" nodes, with syntax highlighting powered by shiki.
Copy file name to clipboardExpand all lines: docs/plugins/shiki/interfaces/ShikiPluginOptions.md
+2-2Lines changed: 2 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,14 +4,14 @@
4
4
5
5
# Interface: ShikiPluginOptions
6
6
7
-
Defined in: [src/plugins/shiki/index.ts:30](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugins/shiki/index.ts#L30)
7
+
Defined in: [src/plugins/shiki/index.ts:30](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugins/shiki/index.ts#L30)
8
8
9
9
## Properties
10
10
11
11
### theme
12
12
13
13
> **theme**: `BundledTheme`
14
14
15
-
Defined in: [src/plugins/shiki/index.ts:34](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugins/shiki/index.ts#L34)
15
+
Defined in: [src/plugins/shiki/index.ts:34](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugins/shiki/index.ts#L34)
0 commit comments