Skip to content

Commit c5b9e55

Browse files
committed
docs: link to main instead of commit
1 parent 23538ff commit c5b9e55

File tree

1 file changed

+25
-23
lines changed

1 file changed

+25
-23
lines changed

README.md

Lines changed: 25 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,8 @@
33
44
# reoff-unified-latex
55

6+
[![npm version](https://badge.fury.io/js/reoff-unified-latex.svg)](https://badge.fury.io/js/reoff-unified-latex) [![npm downloads](https://img.shields.io/npm/dm/reoff-unified-latex.svg)](https://www.npmjs.com/package/reoff-unified-latex)
7+
68
Plugin for `reoff` that takes an `ooxast` tree and turns it into a `unified-latex` tree, allowing for .docx to .tex conversion
79

810
## Contents
@@ -116,7 +118,7 @@ A bibliography you can add manually
116118
117119
Needs to be in CSL format, which will be converted to BibTeX, or in BibTeX format
118120
119-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:145](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L145)
121+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:145](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L145)
120122
121123
##### `bibname?`
122124
@@ -128,7 +130,7 @@ Name of the bibliography file
128130
129131
'bibliography.bib'
130132
131-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:46](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L46)
133+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:46](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L46)
132134
133135
##### `citationType?`
134136
@@ -140,7 +142,7 @@ What type of citation is used?
140142
141143
'zotero'
142144
143-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:69](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L69)
145+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:69](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L69)
144146
145147
##### `collectCitation?`
146148
@@ -165,7 +167,7 @@ Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:69](http
165167
166168
`any`
167169
168-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:71](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L71)
170+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:71](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L71)
169171
170172
##### `columnSeparator?`
171173
@@ -178,7 +180,7 @@ i.e. should `|` be added to the beginning and end of each row?
178180
179181
false
180182
181-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:51](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L51)
183+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:51](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L51)
182184
183185
##### `defaultCol?`
184186
@@ -192,7 +194,7 @@ e.g `l` for left, `r` for right, `c` for center
192194
193195
'l'
194196
195-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:126](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L126)
197+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:126](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L126)
196198
197199
##### `displayMath?`
198200
@@ -210,13 +212,13 @@ What type of display math should be used?
210212
211213
'equation'
212214
213-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:85](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L85)
215+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:85](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L85)
214216
215217
##### `document?`
216218
217219
> `boolean`
218220
219-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:26](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L26)
221+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:26](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L26)
220222
221223
##### `documentClass?`
222224
@@ -240,7 +242,7 @@ Options for the document class
240242
| `name` | `string` | Name of the document class `Default` 'article' |
241243
| `options`? | `string`[] | Options for the document class `Default` undefined |
242244
243-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:55](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L55)
245+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:55](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L55)
244246
245247
##### `handlers?`
246248
@@ -254,7 +256,7 @@ Handlers for specific node types
254256
255257
###### Type declaration
256258
257-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:25](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L25)
259+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:25](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L25)
258260
259261
##### `inlineMath?`
260262
@@ -268,7 +270,7 @@ What type of inline math should be used?
268270
269271
'$'
270272
271-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:101](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L101)
273+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:101](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L101)
272274
273275
##### `italics?`
274276
@@ -280,13 +282,13 @@ Should italics be rendered as \textit or \emph?
280282
281283
'emph'
282284
283-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:42](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L42)
285+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:42](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L42)
284286
285287
##### `newLines?`
286288
287289
> `boolean`
288290
289-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:27](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L27)
291+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:27](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L27)
290292
291293
##### `packages?`
292294
@@ -305,7 +307,7 @@ by default, the following packages are added:
305307
* `caption`
306308
* `tabularx` (if `tabularx` is enabled)
307309
308-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:157](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L157)
310+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:157](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L157)
309311
310312
##### `parseCitation?`
311313
@@ -329,7 +331,7 @@ Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:157](htt
329331
330332
`any`
331333
332-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:70](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L70)
334+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:70](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L70)
333335
334336
##### `preamble?`
335337
@@ -370,13 +372,13 @@ const options = {
370372
}
371373
```
372374
373-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:191](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L191)
375+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:191](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L191)
374376
375377
##### `quotes?`
376378
377379
> `string`[]
378380
379-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:28](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L28)
381+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:28](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L28)
380382
381383
##### `relations?`
382384
@@ -388,13 +390,13 @@ Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:28](http
388390
389391
###### Type declaration
390392
391-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:73](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L73)
393+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:73](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L73)
392394
393395
##### `strikethrough?`
394396
395397
> `"st"` | `"sout"` | `"s"`
396398
397-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:102](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L102)
399+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:102](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L102)
398400
399401
##### `tabularx?`
400402
@@ -408,7 +410,7 @@ Should tabularx be used instead of tabular?
408410
409411
false
410412
411-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:131](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L131)
413+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:131](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L131)
412414
413415
##### `title?`
414416
@@ -422,7 +424,7 @@ If this is not set, the title will be taken from the heading with the "Title" st
422424
423425
undefined
424426
425-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:118](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L118)
427+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:118](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L118)
426428
427429
##### `topSection?`
428430
@@ -437,7 +439,7 @@ What the top section should be
437439
4 = paragraph
438440
5 = subparagraph
439441
440-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:38](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L38)
442+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:38](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L38)
441443
442444
##### `xcolor?`
443445
@@ -452,7 +454,7 @@ and remove color related commands from the output.
452454
453455
true
454456
455-
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:110](https://github.com/TrialAndErrorOrg/parsers/blob/d1cc864/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L110)
457+
Defined in: [libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts:110](https://github.com/TrialAndErrorOrg/parsers/blob/main/libs/ooxast/ooxast-util-to-unified-latex/src/lib/types.ts#L110)
456458
457459
## Syntax tree
458460

0 commit comments

Comments
 (0)