Brunobkr/llama.cpp_AlgMor24_github

1# markdown-table2 3[![Build][build-badge]][build]4[![Coverage][coverage-badge]][coverage]5[![Downloads][downloads-badge]][downloads]6[![Size][size-badge]][size]7 8Generate a markdown ([GFM][]) table.9 10## Contents11 12* [What is this?](#what-is-this)13* [When should I use this?](#when-should-i-use-this)14* [Install](#install)15* [Use](#use)16* [API](#api)17  * [`markdownTable(table[, options])`](#markdowntabletable-options)18* [Types](#types)19* [Compatibility](#compatibility)20* [Security](#security)21* [Inspiration](#inspiration)22* [Contribute](#contribute)23* [License](#license)24 25## What is this?26 27This is a simple package that takes table data and generates a [GitHub flavored28markdown (GFM)][gfm] table.29 30## When should I use this?31 32You can use this package when you want to generate the source code of a GFM33table from some data.34 35This is a simple solution in that it doesn’t handle escapes or HTML or any of36that.37For a complete but heavier solution, build an AST and serialize it with38[`mdast-util-to-markdown`][mdast-util-to-markdown] (with39[`mdast-util-gfm`][mdast-util-gfm]).40 41## Install42 43This package is [ESM only][esm].44In Node.js (version 14.14+, 16.0+), install with [npm][]:45 46```sh47npm install markdown-table48```49 50In Deno with [`esm.sh`][esmsh]:51 52```js53import {markdownTable} from 'https://esm.sh/markdown-table@3'54```55 56In browsers with [`esm.sh`][esmsh]:57 58```html59<script type="module">60  import {markdownTable} from 'https://esm.sh/markdown-table@3?bundle'61</script>62```63 64## Use65 66Typical usage (defaults to align left):67 68```js69import {markdownTable} from 'markdown-table'70 71markdownTable([72  ['Branch', 'Commit'],73  ['main', '0123456789abcdef'],74  ['staging', 'fedcba9876543210']75])76```77 78Yields:79 80```markdown81| Branch  | Commit           |82| ------- | ---------------- |83| main    | 0123456789abcdef |84| staging | fedcba9876543210 |85```86 87With align:88 89```js90markdownTable(91  [92    ['Beep', 'No.', 'Boop'],93    ['beep', '1024', 'xyz'],94    ['boop', '3388450', 'tuv'],95    ['foo', '10106', 'qrstuv'],96    ['bar', '45', 'lmno']97  ],98  {align: ['l', 'c', 'r']}99)100```101 102Yields:103 104```markdown105| Beep |   No.   |   Boop |106| :--- | :-----: | -----: |107| beep |   1024  |    xyz |108| boop | 3388450 |    tuv |109| foo  |  10106  | qrstuv |110| bar  |    45   |   lmno |111```112 113## API114 115This package exports the identifier `markdownTable`.116There is no default export.117 118### `markdownTable(table[, options])`119 120Generate a markdown table from table data (matrix of strings).121 122##### `options`123 124Configuration (optional).125 126###### `options.align`127 128One style for all columns, or styles for their respective columns (`string` or129`Array<string>`).130Each style is either `'l'` (left), `'r'` (right), or `'c'` (center).131Other values are treated as `''`, which doesn’t place the colon in the alignment132row but does align left.133*Only the lowercased first character is used, so `Right` is fine.*134 135###### `options.padding`136 137Whether to add a space of padding between delimiters and cells (`boolean`,138default: `true`).139 140When `true`, there is padding:141 142```markdown143| Alpha | B     |144| ----- | ----- |145| C     | Delta |146```147 148When `false`, there is no padding:149 150```markdown151|Alpha|B    |152|-----|-----|153|C    |Delta|154```155 156###### `options.delimiterStart`157 158Whether to begin each row with the delimiter (`boolean`, default: `true`).159 160> 👉 **Note**: please don’t use this: it could create fragile structures that161> aren’t understandable to some markdown parsers.162 163When `true`, there are starting delimiters:164 165```markdown166| Alpha | B     |167| ----- | ----- |168| C     | Delta |169```170 171When `false`, there are no starting delimiters:172 173```markdown174Alpha | B     |175----- | ----- |176C     | Delta |177```178 179###### `options.delimiterEnd`180 181Whether to end each row with the delimiter (`boolean`, default: `true`).182 183> 👉 **Note**: please don’t use this: it could create fragile structures that184> aren’t understandable to some markdown parsers.185 186When `true`, there are ending delimiters:187 188```markdown189| Alpha | B     |190| ----- | ----- |191| C     | Delta |192```193 194When `false`, there are no ending delimiters:195 196```markdown197| Alpha | B198| ----- | -----199| C     | Delta200```201 202###### `options.alignDelimiters`203 204Whether to align the delimiters (`boolean`, default: `true`).205By default, they are aligned:206 207```markdown208| Alpha | B     |209| ----- | ----- |210| C     | Delta |211```212 213Pass `false` to make them staggered:214 215```markdown216| Alpha | B |217| - | - |218| C | Delta |219```220 221###### `options.stringLength`222 223Function to detect the length of table cell content (`Function`, default:224`s => s.length`).225This is used when aligning the delimiters (`|`) between table cells.226Full-width characters and emoji mess up delimiter alignment when viewing the227markdown source.228To fix this, you can pass this function, which receives the cell content and229returns its “visible” size.230Note that what is and isn’t visible depends on where the text is displayed.231 232Without such a function, the following:233 234```js235markdownTable([236  ['Alpha', 'Bravo'],237  ['中文', 'Charlie'],238  ['👩‍❤️‍👩', 'Delta']239])240```241 242Yields:243 244```markdown245| Alpha | Bravo |246| - | - |247| 中文 | Charlie |248| 👩‍❤️‍👩 | Delta |249```250 251With [`string-width`][string-width]:252 253```js254import stringWidth from 'string-width'255 256markdownTable(257  [258    ['Alpha', 'Bravo'],259    ['中文', 'Charlie'],260    ['👩‍❤️‍👩', 'Delta']261  ],262  {stringLength: stringWidth}263)264```265 266Yields:267 268```markdown269| Alpha | Bravo   |270| ----- | ------- |271| 中文  | Charlie |272| 👩‍❤️‍👩    | Delta   |273```274 275## Types276 277This package is fully typed with [TypeScript][].278It exports the additional type `Options`.279 280## Compatibility281 282This package is at least compatible with all maintained versions of Node.js.283As of now, that is Node.js 14.14+ and 16.0+.284It also works in Deno and modern browsers.285 286## Security287 288This package is safe.289 290## Inspiration291 292The original idea and basic implementation was inspired by James Halliday’s293[`text-table`][text-table] library.294 295## Contribute296 297Yes please!298See [How to Contribute to Open Source][contribute].299 300## License301 302[MIT][license] © [Titus Wormer][author]303 304<!-- Definitions -->305 306[build-badge]: https://github.com/wooorm/markdown-table/workflows/main/badge.svg307 308[build]: https://github.com/wooorm/markdown-table/actions309 310[coverage-badge]: https://img.shields.io/codecov/c/github/wooorm/markdown-table.svg311 312[coverage]: https://codecov.io/github/wooorm/markdown-table313 314[downloads-badge]: https://img.shields.io/npm/dm/markdown-table.svg315 316[downloads]: https://www.npmjs.com/package/markdown-table317 318[size-badge]: https://img.shields.io/bundlephobia/minzip/markdown-table.svg319 320[size]: https://bundlephobia.com/result?p=markdown-table321 322[npm]: https://docs.npmjs.com/cli/install323 324[esmsh]: https://esm.sh325 326[license]: license327 328[author]: https://wooorm.com329 330[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c331 332[typescript]: https://www.typescriptlang.org333 334[contribute]: https://opensource.guide/how-to-contribute/335 336[gfm]: https://docs.github.com/en/github/writing-on-github/working-with-advanced-formatting/organizing-information-with-tables337 338[text-table]: https://github.com/substack/text-table339 340[string-width]: https://github.com/sindresorhus/string-width341 342[mdast-util-to-markdown]: https://github.com/syntax-tree/mdast-util-to-markdown343 344[mdast-util-gfm]: https://github.com/syntax-tree/mdast-util-gfm345