Converts CSV content to Markdown tables.
- Namespace
- Statiq
.Tables - Interfaces
- Base Types
-
- object
- Module
- ParallelSyncModule
graph BT
Type-->Base0["ParallelSyncModule"]
click Base0 "/api/Statiq.Common/ParallelSyncModule"
Base0-->Base1["Module"]
click Base1 "/api/Statiq.Common/Module"
Base1-->Base2["object"]
Type-.->Interface0["IModule"]
click Interface0 "/api/Statiq.Common/IModule"
Type-.->Interface1["IParallelModule"]
click Interface1 "/api/Statiq.Common/IParallelModule"
Type["RenderCsvAsMarkdown"]
class Type type-node
Syntax
public class RenderCsvAsMarkdown : ParallelSyncModule, IModule, IParallelModuleRemarks
This module reads the content of each input document as CSV and outputs an Markdown table
containing the CSV content. The output table has the format
+--------------+-------------+
| Test value 1 | TestValue 2 |
+--------------+-------------+
| Test value 2 | TestValue 3 |
+--------------+-------------+
The input CSV content must use
, as separator and enclose
every value in ".
Properties
| Name | Property Type | Summary |
|---|---|---|
| Parallel | bool |
Indicates whether documents will be
processed by this module in parallel.
Inherited from ParallelSyncModule
|
Methods
| Name | Return Value | Summary |
|---|---|---|
| AfterExecution |
void |
Called after each module execution.
Inherited from Module
|
| AfterExecutionAsync |
Task |
Called after each module execution.
Inherited from Module
|
| BeforeExecution |
void |
Called before each module execution.
Inherited from Module
|
| BeforeExecutionAsync |
Task |
Called before each module execution.
Inherited from Module
|
| ExecuteAsync |
Task |
This should not be called directly, instead call
IExecutionContext.Execute() if you need to execute a module from within another module.
Inherited from Module
|
| ExecuteContextAsync |
Task |
Executes the module once for all input documents.
Inherited from ParallelSyncModule
|
| ExecuteInput |
IEnumerable |
|
| ExecuteInputAsync |
Task |
Executes the module.
Inherited from ParallelSyncModule
|
| Finally |
void |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| FinallyAsync |
Task |
Called after each module execution, even if an exception is thrown during execution.
Inherited from Module
|
| WithHeader |
RenderCsvAsMarkdown |
Treats the first line of input content as a header and generates
<th> tags in the output table.
|