chore: update docs

FelisDiligens · Jan 6, 2025 · ea25ef8 · ea25ef8
1 parent 0a55b82
commit ea25ef8
Show file tree

Hide file tree

Showing 25 changed files with 236 additions and 183 deletions.
diff --git a/README.md b/README.md
@@ -173,20 +173,6 @@ GitHub-flavored Markdown tables (and similar variants) are fully supported, with
 - You **cannot** mix header cells (`<th>`) and ordinary cells (`<td>`) in a single row.
 - You **cannot** independently align cells (only the whole column).
 
-## Caveats
-
-### DokuWiki tables
-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).
-
-These features are not supported by the parser:
-- Vertical table headers
-- Mixed table rows (`^` header cells and `|` normal cells in the same row)
-- Independent (from column) cell alignment (left, center, right)
-
-These features are not supported by the renderer:
-- Table captions
-- Multiline rows
-
 ## Built with...
 
 - written in [TypeScript](https://www.typescriptlang.org/)

diff --git a/docs/README.md b/docs/README.md
@@ -175,20 +175,6 @@ GitHub-flavored Markdown tables (and similar variants) are fully supported, with
 - You **cannot** mix header cells (`<th>`) and ordinary cells (`<td>`) in a single row.
 - You **cannot** independently align cells (only the whole column).
 
-## Caveats
-
-### DokuWiki tables
-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).
-
-These features are not supported by the parser:
-- Vertical table headers
-- Mixed table rows (`^` header cells and `|` normal cells in the same row)
-- Independent (from column) cell alignment (left, center, right)
-
-These features are not supported by the renderer:
-- Table captions
-- Multiline rows
-
 ## Built with...
 
 - written in [TypeScript](https://www.typescriptlang.org/)

diff --git a/docs/classes/CSVTableParser.md b/docs/classes/CSVTableParser.md
@@ -38,7 +38,7 @@
 
 #### Defined in
 
-[tables/csvTable.ts:14](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L14)
+[tables/csvTable.ts:14](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L14)
 
 ## Properties
 
@@ -48,7 +48,7 @@
 
 #### Defined in
 
-[tables/csvTable.ts:17](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L17)
+[tables/csvTable.ts:17](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L17)
 
 ___
 
@@ -58,7 +58,7 @@ ___
 
 #### Defined in
 
-[tables/csvTable.ts:16](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L16)
+[tables/csvTable.ts:16](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L16)
 
 ___
 
@@ -68,7 +68,7 @@ ___
 
 #### Defined in
 
-[tables/csvTable.ts:15](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L15)
+[tables/csvTable.ts:15](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L15)
 
 ## Methods
 
@@ -92,4 +92,4 @@ ___
 
 #### Defined in
 
-[tables/csvTable.ts:19](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L19)
+[tables/csvTable.ts:19](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L19)
diff --git a/docs/classes/CSVTableRenderer.md b/docs/classes/CSVTableRenderer.md
@@ -40,7 +40,7 @@
 
 #### Defined in
 
-[tables/csvTable.ts:91](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L91)
+[tables/csvTable.ts:91](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L91)
 
 ## Properties
 
@@ -50,7 +50,7 @@
 
 #### Defined in
 
-[tables/csvTable.ts:94](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L94)
+[tables/csvTable.ts:94](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L94)
 
 ___
 
@@ -60,7 +60,7 @@ ___
 
 #### Defined in
 
-[tables/csvTable.ts:95](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L95)
+[tables/csvTable.ts:95](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L95)
 
 ___
 
@@ -70,7 +70,7 @@ ___
 
 #### Defined in
 
-[tables/csvTable.ts:93](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L93)
+[tables/csvTable.ts:93](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L93)
 
 ___
 
@@ -80,7 +80,7 @@ ___
 
 #### Defined in
 
-[tables/csvTable.ts:92](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L92)
+[tables/csvTable.ts:92](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L92)
 
 ## Methods
 
@@ -104,4 +104,4 @@ ___
 
 #### Defined in
 
-[tables/csvTable.ts:97](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/csvTable.ts#L97)
+[tables/csvTable.ts:97](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/csvTable.ts#L97)
diff --git a/docs/classes/DokuWikiTableParser.md b/docs/classes/DokuWikiTableParser.md
@@ -2,13 +2,6 @@
 
 # Class: DokuWikiTableParser
 
-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).
-
-These features are not supported:
-- Vertical table headers
-- Mixed table rows (`^` header cells and `|` normal cells in the same row)
-- Independent (from column) cell alignment (left, center, right)
-
 ## Implements
 
 - [`TableParser`](../interfaces/TableParser.md)
@@ -19,6 +12,10 @@ These features are not supported:
 
 - [constructor](DokuWikiTableParser.md#constructor)
 
+### Properties
+
+- [convertMarkup](DokuWikiTableParser.md#convertmarkup)
+
 ### Methods
 
 - [parse](DokuWikiTableParser.md#parse)
@@ -27,7 +24,29 @@ These features are not supported:
 
 ### constructor
 
-• **new DokuWikiTableParser**()
+• **new DokuWikiTableParser**(`convertMarkup?`)
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `convertMarkup` | `boolean` | `true` | If true, converts DokuWiki syntax to Markdown syntax |
+
+#### Defined in
+
+[tables/dokuWikiTable.ts:103](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L103)
+
+## Properties
+
+### convertMarkup
+
+• **convertMarkup**: `boolean` = `true`
+
+If true, converts DokuWiki syntax to Markdown syntax
+
+#### Defined in
+
+[tables/dokuWikiTable.ts:105](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L105)
 
 ## Methods
 
@@ -51,4 +70,4 @@ These features are not supported:
 
 #### Defined in
 
-[tables/dokuWikiTable.ts:35](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L35)
+[tables/dokuWikiTable.ts:108](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L108)
diff --git a/docs/classes/DokuWikiTableRenderer.md b/docs/classes/DokuWikiTableRenderer.md
@@ -2,12 +2,6 @@
 
 # Class: DokuWikiTableRenderer
 
-Not all features are implemented because some features from MultiMarkdown are missing in DokuWiki's syntax (afaik):
-
-These features are not supported:
-- Table captions
-- Multiline rows
-
 ## Implements
 
 - [`TableRenderer`](../interfaces/TableRenderer.md)
@@ -18,19 +12,46 @@ These features are not supported:
 
 - [constructor](DokuWikiTableRenderer.md#constructor)
 
+### Properties
+
+- [convertMarkup](DokuWikiTableRenderer.md#convertmarkup)
+
 ### Methods
 
 - [determineColumnWidths](DokuWikiTableRenderer.md#determinecolumnwidths)
 - [render](DokuWikiTableRenderer.md#render)
 - [renderCaption](DokuWikiTableRenderer.md#rendercaption)
 - [renderCell](DokuWikiTableRenderer.md#rendercell)
 - [renderRow](DokuWikiTableRenderer.md#renderrow)
+- [renderText](DokuWikiTableRenderer.md#rendertext)
 
 ## Constructors
 
 ### constructor
 
-• **new DokuWikiTableRenderer**()
+• **new DokuWikiTableRenderer**(`convertMarkup?`)
+
+#### Parameters
+
+| Name | Type | Default value | Description |
+| :------ | :------ | :------ | :------ |
+| `convertMarkup` | `boolean` | `true` | If true, converts Markdown syntax to DokuWiki syntax |
+
+#### Defined in
+
+[tables/dokuWikiTable.ts:235](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L235)
+
+## Properties
+
+### convertMarkup
+
+• **convertMarkup**: `boolean` = `true`
+
+If true, converts Markdown syntax to DokuWiki syntax
+
+#### Defined in
+
+[tables/dokuWikiTable.ts:237](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L237)
 
 ## Methods
 
@@ -50,7 +71,7 @@ These features are not supported:
 
 #### Defined in
 
-[tables/dokuWikiTable.ts:250](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L250)
+[tables/dokuWikiTable.ts:339](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L339)
 
 ___
 
@@ -74,7 +95,7 @@ ___
 
 #### Defined in
 
-[tables/dokuWikiTable.ts:151](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L151)
+[tables/dokuWikiTable.ts:240](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L240)
 
 ___
 
@@ -94,7 +115,7 @@ ___
 
 #### Defined in
 
-[tables/dokuWikiTable.ts:191](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L191)
+[tables/dokuWikiTable.ts:272](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L272)
 
 ___
 
@@ -116,21 +137,20 @@ ___
 
 #### Defined in
 
-[tables/dokuWikiTable.ts:226](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L226)
+[tables/dokuWikiTable.ts:308](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L308)
 
 ___
 
 ### renderRow
 
-▸ `Private` **renderRow**(`table`, `row`, `isHeader`, `columnWidths`): `string`
+▸ `Private` **renderRow**(`table`, `row`, `columnWidths`): `string`
 
 #### Parameters
 
 | Name | Type |
 | :------ | :------ |
 | `table` | [`Table`](Table.md) |
 | `row` | [`TableRow`](TableRow.md) |
-| `isHeader` | `boolean` |
 | `columnWidths` | `number`[] |
 
 #### Returns
@@ -139,4 +159,24 @@ ___
 
 #### Defined in
 
-[tables/dokuWikiTable.ts:203](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/dokuWikiTable.ts#L203)
+[tables/dokuWikiTable.ts:284](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L284)
+
+___
+
+### renderText
+
+▸ `Private` **renderText**(`text`): `string`
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `text` | `string` |
+
+#### Returns
+
+`string`
+
+#### Defined in
+
+[tables/dokuWikiTable.ts:335](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/dokuWikiTable.ts#L335)
diff --git a/docs/classes/GitHubFlavoredMarkdownTableParser.md b/docs/classes/GitHubFlavoredMarkdownTableParser.md
@@ -44,4 +44,4 @@
 
 #### Defined in
 
-[tables/gfmTable.ts:22](https://github.com/FelisDiligens/md-table-tools/blob/c0688b5/src/tables/gfmTable.ts#L22)
+[tables/gfmTable.ts:22](https://github.com/FelisDiligens/md-table-tools/blob/0a55b82/src/tables/gfmTable.ts#L22)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -44,4 +44,4 @@

		#### Defined in

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