Skip to content

Commit d3d4969

Browse files
committed
0.3.27
1 parent 8201558 commit d3d4969

12 files changed

Lines changed: 59 additions & 59 deletions

File tree

docs/index/interfaces/DocxOptions.md

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
# Interface: DocxOptions
66

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)
88

99
## Extends
1010

@@ -14,19 +14,19 @@ Defined in: [src/mdast-util-to-docx.ts:188](https://github.com/inokawa/remark-do
1414

1515
### size?
1616

17-
> `optional` **size**: `object`
17+
> `optional` **size?**: `object`
1818
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)
2020

2121
Page size defined in twip (1 twip == 1/1440 inch).
2222

2323
#### width?
2424

25-
> `optional` **width**: `number`
25+
> `optional` **width?**: `number`
2626
2727
#### height?
2828

29-
> `optional` **height**: `number`
29+
> `optional` **height?**: `number`
3030
3131
#### Default
3232

@@ -36,27 +36,27 @@ A4 (sectionPageSizeDefaults)
3636

3737
### margin?
3838

39-
> `optional` **margin**: `object`
39+
> `optional` **margin?**: `object`
4040
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)
4242

4343
Page margin defined in twip (1 twip == 1/1440 inch).
4444

4545
#### top?
4646

47-
> `optional` **top**: `number`
47+
> `optional` **top?**: `number`
4848
4949
#### left?
5050

51-
> `optional` **left**: `number`
51+
> `optional` **left?**: `number`
5252
5353
#### bottom?
5454

55-
> `optional` **bottom**: `number`
55+
> `optional` **bottom?**: `number`
5656
5757
#### right?
5858

59-
> `optional` **right**: `number`
59+
> `optional` **right?**: `number`
6060
6161
#### Default
6262

@@ -66,9 +66,9 @@ Page margin defined in twip (1 twip == 1/1440 inch).
6666

6767
### orientation?
6868

69-
> `optional` **orientation**: `"portrait"` \| `"landscape"`
69+
> `optional` **orientation?**: `"portrait"` \| `"landscape"`
7070
71-
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)
7272

7373
Page orientation.
7474

@@ -82,9 +82,9 @@ Page orientation.
8282

8383
### columns?
8484

85-
> `optional` **columns**: `number`
85+
> `optional` **columns?**: `number`
8686
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)
8888

8989
Number of page columns.
9090

@@ -98,9 +98,9 @@ Number of page columns.
9898

9999
### spacing?
100100

101-
> `optional` **spacing**: `number`
101+
> `optional` **spacing?**: `number`
102102
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)
104104

105105
Spacing after Paragraphs in twip (1 twip == 1/1440 inch).
106106

@@ -114,9 +114,9 @@ Spacing after Paragraphs in twip (1 twip == 1/1440 inch).
114114

115115
### direction?
116116

117-
> `optional` **direction**: `"ltr"` \| `"rtl"` \| `"vertical"`
117+
> `optional` **direction?**: `"ltr"` \| `"rtl"` \| `"vertical"`
118118
119-
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)
120120

121121
Direction of texts.
122122

@@ -130,9 +130,9 @@ Direction of texts.
130130

131131
### orderedListFormat?
132132

133-
> `optional` **orderedListFormat**: `ListFormat`[]
133+
> `optional` **orderedListFormat?**: `ListFormat`[]
134134
135-
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)
136136

137137
An option to override the text format of ordered list.
138138
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.
141141

142142
### thematicBreak?
143143

144-
> `optional` **thematicBreak**: `ThematicBreakType`
144+
> `optional` **thematicBreak?**: `ThematicBreakType`
145145
146-
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)
147147

148148
An option to select how thematicBreak works.
149149

@@ -161,19 +161,19 @@ An option to select how thematicBreak works.
161161

162162
### plugins?
163163

164-
> `optional` **plugins**: [`RemarkDocxPlugin`](../type-aliases/RemarkDocxPlugin.md)[]
164+
> `optional` **plugins?**: [`RemarkDocxPlugin`](../type-aliases/RemarkDocxPlugin.md)[]
165165
166-
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)
167167

168168
Plugins to customize how mdast nodes are compiled.
169169

170170
***
171171

172172
### title?
173173

174-
> `readonly` `optional` **title**: `string`
174+
> `readonly` `optional` **title?**: `string`
175175
176-
Defined in: node\_modules/docx/dist/index.d.ts:1415
176+
Defined in: node\_modules/docx/dist/index.d.ts:1569
177177

178178
#### Inherited from
179179

@@ -183,9 +183,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1415
183183

184184
### subject?
185185

186-
> `readonly` `optional` **subject**: `string`
186+
> `readonly` `optional` **subject?**: `string`
187187
188-
Defined in: node\_modules/docx/dist/index.d.ts:1416
188+
Defined in: node\_modules/docx/dist/index.d.ts:1570
189189

190190
#### Inherited from
191191

@@ -195,9 +195,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1416
195195

196196
### creator?
197197

198-
> `readonly` `optional` **creator**: `string`
198+
> `readonly` `optional` **creator?**: `string`
199199
200-
Defined in: node\_modules/docx/dist/index.d.ts:1417
200+
Defined in: node\_modules/docx/dist/index.d.ts:1571
201201

202202
#### Inherited from
203203

@@ -207,9 +207,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1417
207207

208208
### keywords?
209209

210-
> `readonly` `optional` **keywords**: `string`
210+
> `readonly` `optional` **keywords?**: `string`
211211
212-
Defined in: node\_modules/docx/dist/index.d.ts:1418
212+
Defined in: node\_modules/docx/dist/index.d.ts:1572
213213

214214
#### Inherited from
215215

@@ -219,9 +219,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1418
219219

220220
### description?
221221

222-
> `readonly` `optional` **description**: `string`
222+
> `readonly` `optional` **description?**: `string`
223223
224-
Defined in: node\_modules/docx/dist/index.d.ts:1419
224+
Defined in: node\_modules/docx/dist/index.d.ts:1573
225225

226226
#### Inherited from
227227

@@ -231,9 +231,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1419
231231

232232
### styles?
233233

234-
> `readonly` `optional` **styles**: `IStylesOptions`
234+
> `readonly` `optional` **styles?**: `IStylesOptions`
235235
236-
Defined in: node\_modules/docx/dist/index.d.ts:1423
236+
Defined in: node\_modules/docx/dist/index.d.ts:1577
237237

238238
#### Inherited from
239239

@@ -243,9 +243,9 @@ Defined in: node\_modules/docx/dist/index.d.ts:1423
243243

244244
### background?
245245

246-
> `readonly` `optional` **background**: `IDocumentBackgroundOptions`
246+
> `readonly` `optional` **background?**: `IDocumentBackgroundOptions`
247247
248-
Defined in: node\_modules/docx/dist/index.d.ts:1429
248+
Defined in: node\_modules/docx/dist/index.d.ts:1586
249249

250250
#### Inherited from
251251

docs/index/type-aliases/RemarkDocxPlugin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,11 @@
22

33
***
44

5-
# Type Alias: RemarkDocxPlugin()
5+
# Type Alias: RemarkDocxPlugin
66

77
> **RemarkDocxPlugin** = (`ctx`) => `Promise`\<`NodeBuilders`\>
88
9-
Defined in: [src/types.ts:93](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/types.ts#L93)
9+
Defined in: [src/types.ts:93](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/types.ts#L93)
1010

1111
## Parameters
1212

docs/index/variables/default.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,4 +6,4 @@
66

77
> `const` **default**: `Plugin`\<\[[`DocxOptions`](../interfaces/DocxOptions.md)?\], `Root`, `Promise`\<`ArrayBuffer`\>\>
88
9-
Defined in: [src/plugin.ts:13](https://github.com/inokawa/remark-docx/blob/b937c08ac4cbc850df98aebcd10a83f7274f9c72/src/plugin.ts#L13)
9+
Defined in: [src/plugin.ts:13](https://github.com/inokawa/remark-docx/blob/82015585db17f0921fa08ccb6e9e326278fa3244/src/plugin.ts#L13)

docs/plugins/html/functions/htmlPlugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
> **htmlPlugin**(): [`RemarkDocxPlugin`](../../../index/type-aliases/RemarkDocxPlugin.md)
88
9-
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)
1010

1111
A plugin to render "html" node.
1212

docs/plugins/image/functions/imagePlugin.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
# Function: imagePlugin()
66

7-
> **imagePlugin**(`__namedParameters`): [`RemarkDocxPlugin`](../../../index/type-aliases/RemarkDocxPlugin.md)
7+
> **imagePlugin**(`__namedParameters?`): [`RemarkDocxPlugin`](../../../index/type-aliases/RemarkDocxPlugin.md)
88
9-
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)
1010

1111
A plugin to render "image" nodes
1212

1313
## Parameters
1414

15-
### \_\_namedParameters
15+
### \_\_namedParameters?
1616

1717
[`ImagePluginOptions`](../interfaces/ImagePluginOptions.md) = `{}`
1818

docs/plugins/image/interfaces/ImagePluginOptions.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44

55
# Interface: ImagePluginOptions
66

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)
88

99
## Properties
1010

1111
### load?
1212

13-
> `optional` **load**: `LoadFn`
13+
> `optional` **load?**: `LoadFn`
1414
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)
1616

1717
A function to resolve image data from url.
1818

@@ -24,9 +24,9 @@ loadWithFetch
2424

2525
### fallbackSvg?
2626

27-
> `optional` **fallbackSvg**: `SvgToPngFn`
27+
> `optional` **fallbackSvg?**: `SvgToPngFn`
2828
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)
3030

3131
A function to convert SVG to PNG. According to the docx specifications, embedding SVG images also requires including PNG.
3232

docs/plugins/latex/functions/latexPlugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
> **latexPlugin**(): [`RemarkDocxPlugin`](../../../index/type-aliases/RemarkDocxPlugin.md)
88
9-
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)
1010

1111
A plugin to render LaTeX inside "math" and "inlineMath" nodes
1212

docs/plugins/mermaid/functions/mermaidPlugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
> **mermaidPlugin**(): [`RemarkDocxPlugin`](../../../index/type-aliases/RemarkDocxPlugin.md)
88
9-
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)
1010

1111
A plugin to render Mermaid inside "code" nodes with "mermaid" language.
1212

docs/plugins/shiki/functions/shikiPlugin.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
> **shikiPlugin**(`__namedParameters`): [`RemarkDocxPlugin`](../../../index/type-aliases/RemarkDocxPlugin.md)
88
9-
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)
1010

1111
A plugin to render "code" nodes, with syntax highlighting powered by shiki.
1212

docs/plugins/shiki/interfaces/ShikiPluginOptions.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,14 @@
44

55
# Interface: ShikiPluginOptions
66

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)
88

99
## Properties
1010

1111
### theme
1212

1313
> **theme**: `BundledTheme`
1414
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)
1616

1717
https://shiki.style/themes

0 commit comments

Comments
 (0)