Skip to content

Commit ea25ef8

Browse files
committed
chore: update docs
1 parent 0a55b82 commit ea25ef8

25 files changed

+236
-183
lines changed

README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -173,20 +173,6 @@ GitHub-flavored Markdown tables (and similar variants) are fully supported, with
173173
- You **cannot** mix header cells (`<th>`) and ordinary cells (`<td>`) in a single row.
174174
- You **cannot** independently align cells (only the whole column).
175175

176-
## Caveats
177-
178-
### DokuWiki tables
179-
Not all features of DokuWiki's tables are implemented due to the way the intermediary data is laid out (the library focuses on MultiMarkdown's feature set).
180-
181-
These features are not supported by the parser:
182-
- Vertical table headers
183-
- Mixed table rows (`^` header cells and `|` normal cells in the same row)
184-
- Independent (from column) cell alignment (left, center, right)
185-
186-
These features are not supported by the renderer:
187-
- Table captions
188-
- Multiline rows
189-
190176
## Built with...
191177

192178
- written in [TypeScript](https://www.typescriptlang.org/)

docs/README.md

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -175,20 +175,6 @@ GitHub-flavored Markdown tables (and similar variants) are fully supported, with
175175
- You **cannot** mix header cells (`<th>`) and ordinary cells (`<td>`) in a single row.
176176
- You **cannot** independently align cells (only the whole column).
177177

178-
## Caveats
179-
180-
### DokuWiki tables
181-
Not all features of DokuWiki's tables are implemented due to the way the intermediary data is laid out (the library focuses on MultiMarkdown's feature set).
182-
183-
These features are not supported by the parser:
184-
- Vertical table headers
185-
- Mixed table rows (`^` header cells and `|` normal cells in the same row)
186-
- Independent (from column) cell alignment (left, center, right)
187-
188-
These features are not supported by the renderer:
189-
- Table captions
190-
- Multiline rows
191-
192178
## Built with...
193179

194180
- written in [TypeScript](https://www.typescriptlang.org/)

docs/classes/CSVTableParser.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838

3939
#### Defined in
4040

41-
[tables/csvTable.ts:14](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L14)
41+
[tables/csvTable.ts:14](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L14)
4242

4343
## Properties
4444

@@ -48,7 +48,7 @@
4848

4949
#### Defined in
5050

51-
[tables/csvTable.ts:17](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L17)
51+
[tables/csvTable.ts:17](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L17)
5252

5353
___
5454

@@ -58,7 +58,7 @@ ___
5858

5959
#### Defined in
6060

61-
[tables/csvTable.ts:16](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L16)
61+
[tables/csvTable.ts:16](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L16)
6262

6363
___
6464

@@ -68,7 +68,7 @@ ___
6868

6969
#### Defined in
7070

71-
[tables/csvTable.ts:15](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L15)
71+
[tables/csvTable.ts:15](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L15)
7272

7373
## Methods
7474

@@ -92,4 +92,4 @@ ___
9292

9393
#### Defined in
9494

95-
[tables/csvTable.ts:19](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L19)
95+
[tables/csvTable.ts:19](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L19)

docs/classes/CSVTableRenderer.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@
4040

4141
#### Defined in
4242

43-
[tables/csvTable.ts:91](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L91)
43+
[tables/csvTable.ts:91](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L91)
4444

4545
## Properties
4646

@@ -50,7 +50,7 @@
5050

5151
#### Defined in
5252

53-
[tables/csvTable.ts:94](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L94)
53+
[tables/csvTable.ts:94](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L94)
5454

5555
___
5656

@@ -60,7 +60,7 @@ ___
6060

6161
#### Defined in
6262

63-
[tables/csvTable.ts:95](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L95)
63+
[tables/csvTable.ts:95](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L95)
6464

6565
___
6666

@@ -70,7 +70,7 @@ ___
7070

7171
#### Defined in
7272

73-
[tables/csvTable.ts:93](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L93)
73+
[tables/csvTable.ts:93](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L93)
7474

7575
___
7676

@@ -80,7 +80,7 @@ ___
8080

8181
#### Defined in
8282

83-
[tables/csvTable.ts:92](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L92)
83+
[tables/csvTable.ts:92](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L92)
8484

8585
## Methods
8686

@@ -104,4 +104,4 @@ ___
104104

105105
#### Defined in
106106

107-
[tables/csvTable.ts:97](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L97)
107+
[tables/csvTable.ts:97](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L97)

docs/classes/DokuWikiTableParser.md

Lines changed: 28 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,13 +2,6 @@
22

33
# Class: DokuWikiTableParser
44

5-
Not all features of DokuWiki's tables are implemented due to the way the intermediary data is laid out (the library focuses on MultiMarkdown's feature set).
6-
7-
These features are not supported:
8-
- Vertical table headers
9-
- Mixed table rows (`^` header cells and `|` normal cells in the same row)
10-
- Independent (from column) cell alignment (left, center, right)
11-
125
## Implements
136

147
- [`TableParser`](../interfaces/TableParser.md)
@@ -19,6 +12,10 @@ These features are not supported:
1912

2013
- [constructor](DokuWikiTableParser.md#constructor)
2114

15+
### Properties
16+
17+
- [convertMarkup](DokuWikiTableParser.md#convertmarkup)
18+
2219
### Methods
2320

2421
- [parse](DokuWikiTableParser.md#parse)
@@ -27,7 +24,29 @@ These features are not supported:
2724

2825
### constructor
2926

30-
**new DokuWikiTableParser**()
27+
**new DokuWikiTableParser**(`convertMarkup?`)
28+
29+
#### Parameters
30+
31+
| Name | Type | Default value | Description |
32+
| :------ | :------ | :------ | :------ |
33+
| `convertMarkup` | `boolean` | `true` | If true, converts DokuWiki syntax to Markdown syntax |
34+
35+
#### Defined in
36+
37+
[tables/dokuWikiTable.ts:103](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L103)
38+
39+
## Properties
40+
41+
### convertMarkup
42+
43+
**convertMarkup**: `boolean` = `true`
44+
45+
If true, converts DokuWiki syntax to Markdown syntax
46+
47+
#### Defined in
48+
49+
[tables/dokuWikiTable.ts:105](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L105)
3150

3251
## Methods
3352

@@ -51,4 +70,4 @@ These features are not supported:
5170

5271
#### Defined in
5372

54-
[tables/dokuWikiTable.ts:35](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L35)
73+
[tables/dokuWikiTable.ts:108](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L108)

docs/classes/DokuWikiTableRenderer.md

Lines changed: 54 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,6 @@
22

33
# Class: DokuWikiTableRenderer
44

5-
Not all features are implemented because some features from MultiMarkdown are missing in DokuWiki's syntax (afaik):
6-
7-
These features are not supported:
8-
- Table captions
9-
- Multiline rows
10-
115
## Implements
126

137
- [`TableRenderer`](../interfaces/TableRenderer.md)
@@ -18,19 +12,46 @@ These features are not supported:
1812

1913
- [constructor](DokuWikiTableRenderer.md#constructor)
2014

15+
### Properties
16+
17+
- [convertMarkup](DokuWikiTableRenderer.md#convertmarkup)
18+
2119
### Methods
2220

2321
- [determineColumnWidths](DokuWikiTableRenderer.md#determinecolumnwidths)
2422
- [render](DokuWikiTableRenderer.md#render)
2523
- [renderCaption](DokuWikiTableRenderer.md#rendercaption)
2624
- [renderCell](DokuWikiTableRenderer.md#rendercell)
2725
- [renderRow](DokuWikiTableRenderer.md#renderrow)
26+
- [renderText](DokuWikiTableRenderer.md#rendertext)
2827

2928
## Constructors
3029

3130
### constructor
3231

33-
**new DokuWikiTableRenderer**()
32+
**new DokuWikiTableRenderer**(`convertMarkup?`)
33+
34+
#### Parameters
35+
36+
| Name | Type | Default value | Description |
37+
| :------ | :------ | :------ | :------ |
38+
| `convertMarkup` | `boolean` | `true` | If true, converts Markdown syntax to DokuWiki syntax |
39+
40+
#### Defined in
41+
42+
[tables/dokuWikiTable.ts:235](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L235)
43+
44+
## Properties
45+
46+
### convertMarkup
47+
48+
**convertMarkup**: `boolean` = `true`
49+
50+
If true, converts Markdown syntax to DokuWiki syntax
51+
52+
#### Defined in
53+
54+
[tables/dokuWikiTable.ts:237](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L237)
3455

3556
## Methods
3657

@@ -50,7 +71,7 @@ These features are not supported:
5071

5172
#### Defined in
5273

53-
[tables/dokuWikiTable.ts:250](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L250)
74+
[tables/dokuWikiTable.ts:339](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L339)
5475

5576
___
5677

@@ -74,7 +95,7 @@ ___
7495

7596
#### Defined in
7697

77-
[tables/dokuWikiTable.ts:151](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L151)
98+
[tables/dokuWikiTable.ts:240](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L240)
7899

79100
___
80101

@@ -94,7 +115,7 @@ ___
94115

95116
#### Defined in
96117

97-
[tables/dokuWikiTable.ts:191](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L191)
118+
[tables/dokuWikiTable.ts:272](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L272)
98119

99120
___
100121

@@ -116,21 +137,20 @@ ___
116137

117138
#### Defined in
118139

119-
[tables/dokuWikiTable.ts:226](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L226)
140+
[tables/dokuWikiTable.ts:308](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L308)
120141

121142
___
122143

123144
### renderRow
124145

125-
`Private` **renderRow**(`table`, `row`, `isHeader`, `columnWidths`): `string`
146+
`Private` **renderRow**(`table`, `row`, `columnWidths`): `string`
126147

127148
#### Parameters
128149

129150
| Name | Type |
130151
| :------ | :------ |
131152
| `table` | [`Table`](Table.md) |
132153
| `row` | [`TableRow`](TableRow.md) |
133-
| `isHeader` | `boolean` |
134154
| `columnWidths` | `number`[] |
135155

136156
#### Returns
@@ -139,4 +159,24 @@ ___
139159

140160
#### Defined in
141161

142-
[tables/dokuWikiTable.ts:203](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L203)
162+
[tables/dokuWikiTable.ts:284](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L284)
163+
164+
___
165+
166+
### renderText
167+
168+
`Private` **renderText**(`text`): `string`
169+
170+
#### Parameters
171+
172+
| Name | Type |
173+
| :------ | :------ |
174+
| `text` | `string` |
175+
176+
#### Returns
177+
178+
`string`
179+
180+
#### Defined in
181+
182+
[tables/dokuWikiTable.ts:335](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L335)

docs/classes/GitHubFlavoredMarkdownTableParser.md

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

4545
#### Defined in
4646

47-
[tables/gfmTable.ts:22](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/gfmTable.ts#L22)
47+
[tables/gfmTable.ts:22](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/gfmTable.ts#L22)

0 commit comments

Comments
 (0)