Skip to content

ryohidaka/format-md-table

Repository files navigation

format-md-table

npm version build codecov License

ko-fi

Overview

Library to format only table elements in Markdown.

Notes

Installation

You can install this library using npm:

npm install format-md-table

Usage

import { formatMarkdownTable } from "format-md-table";

const markdownString = `
|Name|Age|Gender|
|-|-|-|
|Alice|30|Female|
|Bob|25|Male|
|Charlie|40|Male|
|David|35|Male|
`;

const formattedMarkdown = formatMarkdownTable(markdownString);
console.log(formattedMarkdown);

API

formatMarkdownTable(markdownString: string = ""): string Formats the markdown tables within the given markdown string.

markdownString (optional): The markdown string to format. If not provided, an empty string is used. Returns the formatted markdown string.

Example

Input:

|Name|Age|Gender|
|-|-|-|
|Alice|30|Female|
|Bob|25|Male|
|Charlie|40|Male|
|David|35|Male|

Output:

| Name    | Age | Gender |
| ------- | --- | ------ |
| Alice   | 30  | Female |
| Bob     | 25  | Male   |
| Charlie | 40  | Male   |
| David   | 35  | Male   |

License

This project is licensed under the MIT License - see the LICENSE file for details.