ts-markdown-builder 0.1.0 → 0.2.1

package/README.md

@@ -10,11 +10,10 @@ Elegant markdown builder with minimal bundle size.
 
 ## Goal
 
-TODO
-
-```ts
-TODO;
-```
+TypeScript markdown generation library:
+- easy to read and write API
+- build CommonMark & GFM compliant markdown
+- minimal bundle size + tree-shakable 
 
 ## Installation
 
@@ -27,7 +26,32 @@ npm install ts-markdown-builder
 ```js
 import * as md from 'ts-markdown-builder';
 
-const output = md.heading('Hello World', 1);
+const output = md.joinBlocks([
+  md.heading('Welcome to TS Markdown Builder'),
+  "It's an easy to use modern markdown generator.",
+  'It supports:',
+  md.list([
+    `${md.bold('bold')} and ${md.italic('italic')}`,
+    `${md.code('code')} spans and code blocks`,
+    'unordered and ordered lists',
+    'blockquotes',
+    'and more!',
+  ]),
+]);
+```
+
+```markdown
+# Welcome to TS Markdown Builder
+
+It's an easy to use modern markdown generator.
+
+It supports:
+
+- **bold** and *italic*
+- \`code\` spans and code blocks
+- unordered and ordered lists
+- blockquotes
+- and more!
 ```
 
 ## Contributing

package/dist/commonjs/block.js

@@ -4,23 +4,23 @@ exports.blockquote = blockquote;
 exports.codeBlock = codeBlock;
 exports.heading = heading;
 exports.horizontalRule = void 0;
+exports.list = list;
 exports.orderedList = orderedList;
-exports.unorderedList = unorderedList;
 var _utils = require("./utils.js");
 const horizontalRule = exports.horizontalRule = '\n---\n';
 function heading(text, level = 1) {
   return `${'#'.repeat(level)} ${text}`;
 }
-function blockquote(text) {
-  return (0, _utils.prefixLines)(text, '> ');
+function blockquote(content) {
+  return (0, _utils.prefixLines)(content, '> ');
 }
-function codeBlock(text) {
-  return `\`\`\`\n${text}\n\`\`\``;
+function codeBlock(content) {
+  return `\`\`\`\n${content}\n\`\`\``;
+}
+function list(items) {
+  return items.map(item => `- ${item}`).join('\n');
 }
 function orderedList(items) {
   return items.map((item, index) => `${index + 1}. ${item}`).join('\n');
 }
-function unorderedList(items) {
-  return items.map(item => `- ${item}`).join('\n');
-}
 //# sourceMappingURL=block.js.map

package/dist/commonjs/block.js.map

@@ -1 +1 @@
-{"version":3,"file":"block.js","names":["horizontalRule","exports","heading","text","level","repeat","blockquote","prefixLines","codeBlock","orderedList","items","map","item","index","join","unorderedList"],"sources":["../../src/block.ts"],"sourcesContent":["import { prefixLines } from './utils';\n\n// Ref: https://www.markdownguide.org/basic-syntax/\n\nexport const horizontalRule = '\\n---\\n';\n\nexport function heading(text: string, level: number = 1): string {\n  return `${'#'.repeat(level)} ${text}`;\n}\n\nexport function blockquote(text: string): string {\n  return prefixLines(text, '> ');\n}\n\nexport function codeBlock(text: string): string {\n  return `\\`\\`\\`\\n${text}\\n\\`\\`\\``;\n}\n\nexport function orderedList(items: string[]): string {\n  return items.map((item, index) => `${index + 1}. ${item}`).join('\\n');\n}\n\nexport function unorderedList(items: string[]): string {\n  return items.map((item) => `- ${item}`).join('\\n');\n}\n"],"mappings":";;;;;;;;;AAIO,MAAMA,cAAc,GAAAC,OAAA,CAAAD,cAAA,GAAG,SAAS;AAEhC,SAASE,OAAOA,CAACC,IAAY,EAAEC,KAAa,GAAG,CAAC,EAAU;EAC/D,OAAO,GAAG,GAAG,CAACC,MAAM,CAACD,KAAK,CAAC,IAAID,IAAI,EAAE;AACvC;AAEO,SAASG,UAAUA,CAACH,IAAY,EAAU;EAC/C,OAAO,IAAAI,kBAAW,EAACJ,IAAI,EAAE,IAAI,CAAC;AAChC;AAEO,SAASK,SAASA,CAACL,IAAY,EAAU;EAC9C,OAAO,WAAWA,IAAI,UAAU;AAClC;AAEO,SAASM,WAAWA,CAACC,KAAe,EAAU;EACnD,OAAOA,KAAK,CAACC,GAAG,CAAC,CAACC,IAAI,EAAEC,KAAK,KAAK,GAAGA,KAAK,GAAG,CAAC,KAAKD,IAAI,EAAE,CAAC,CAACE,IAAI,CAAC,IAAI,CAAC;AACvE;AAEO,SAASC,aAAaA,CAACL,KAAe,EAAU;EACrD,OAAOA,KAAK,CAACC,GAAG,CAAEC,IAAI,IAAK,KAAKA,IAAI,EAAE,CAAC,CAACE,IAAI,CAAC,IAAI,CAAC;AACpD","ignoreList":[]}
+{"version":3,"file":"block.js","names":["horizontalRule","exports","heading","text","level","repeat","blockquote","content","prefixLines","codeBlock","list","items","map","item","join","orderedList","index"],"sources":["../../src/block.ts"],"sourcesContent":["import { prefixLines } from './utils';\n\n/**\n * Create a horizontal rule block.\n *\n * Markdown: `---`\n */\nexport const horizontalRule = '\\n---\\n';\n\n/**\n * Create a heading block.\n * Markdown: `# Heading`\n *\n * @param text - The text of the heading.\n * @param level - The level of the heading (defaults to 1).\n */\nexport function heading(text: string, level: number = 1): string {\n  return `${'#'.repeat(level)} ${text}`;\n}\n\n/**\n * Create a blockquote block.\n *\n * Markdown:\n * ```\n * > Content\n * > Content\n * ```\n *\n * @param text - The content of the blockquote.\n */\nexport function blockquote(content: string): string {\n  return prefixLines(content, '> ');\n}\n\n/**\n * Create a code block.\n *\n * Markdown:\n * ````\n * ```\n * Content\n * ```\n * ````\n *\n * @param content - The content of the code block.\n */\nexport function codeBlock(content: string): string {\n  return `\\`\\`\\`\\n${content}\\n\\`\\`\\``;\n}\n\n/**\n * Create an unordered list block.\n *\n * Markdown:\n * ```\n * - Item\n * - Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function list(items: string[]): string {\n  return items.map((item) => `- ${item}`).join('\\n');\n}\n\n/**\n * Create an ordered list block.\n *\n * Markdown:\n * ```\n * 1. Item\n * 2. Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function orderedList(items: string[]): string {\n  return items.map((item, index) => `${index + 1}. ${item}`).join('\\n');\n}\n"],"mappings":";;;;;;;;;AAOO,MAAMA,cAAc,GAAAC,OAAA,CAAAD,cAAA,GAAG,SAAS;AAShC,SAASE,OAAOA,CAACC,IAAY,EAAEC,KAAa,GAAG,CAAC,EAAU;EAC/D,OAAO,GAAG,GAAG,CAACC,MAAM,CAACD,KAAK,CAAC,IAAID,IAAI,EAAE;AACvC;AAaO,SAASG,UAAUA,CAACC,OAAe,EAAU;EAClD,OAAO,IAAAC,kBAAW,EAACD,OAAO,EAAE,IAAI,CAAC;AACnC;AAcO,SAASE,SAASA,CAACF,OAAe,EAAU;EACjD,OAAO,WAAWA,OAAO,UAAU;AACrC;AAaO,SAASG,IAAIA,CAACC,KAAe,EAAU;EAC5C,OAAOA,KAAK,CAACC,GAAG,CAAEC,IAAI,IAAK,KAAKA,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACpD;AAaO,SAASC,WAAWA,CAACJ,KAAe,EAAU;EACnD,OAAOA,KAAK,CAACC,GAAG,CAAC,CAACC,IAAI,EAAEG,KAAK,KAAK,GAAGA,KAAK,GAAG,CAAC,KAAKH,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACvE","ignoreList":[]}

package/dist/commonjs/html.js

@@ -0,0 +1,7 @@
+"use strict";
+
+exports.disclosure = disclosure;
+function disclosure(title, content) {
+  return `<details>\n<summary>${title}</summary>\n${content}\n</details>`;
+}
+//# sourceMappingURL=html.js.map

package/dist/commonjs/html.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.js","names":["disclosure","title","content"],"sources":["../../src/html.ts"],"sourcesContent":["/**\n * Create a disclosure block.\n *\n * Markdown/Html:\n * ```\n * <details>\n *   <summary>Title</summary>\n *   Content\n * </details>\n * ```\n *\n * @param title - The title of the disclosure.\n * @param content - The content of the disclosure.\n */\nexport function disclosure(title: string, content: string): string {\n  return `<details>\\n<summary>${title}</summary>\\n${content}\\n</details>`;\n}\n"],"mappings":";;;AAcO,SAASA,UAAUA,CAACC,KAAa,EAAEC,OAAe,EAAU;EACjE,OAAO,uBAAuBD,KAAK,eAAeC,OAAO,cAAc;AACzE","ignoreList":[]}

package/dist/commonjs/index.js

@@ -24,6 +24,12 @@ Object.defineProperty(exports, "codeBlock", {
     return _block.codeBlock;
   }
 });
+Object.defineProperty(exports, "disclosure", {
+  enumerable: true,
+  get: function () {
+    return _html.disclosure;
+  }
+});
 Object.defineProperty(exports, "heading", {
   enumerable: true,
   get: function () {
@@ -48,6 +54,12 @@ Object.defineProperty(exports, "italic", {
     return _inline.italic;
   }
 });
+Object.defineProperty(exports, "joinBlocks", {
+  enumerable: true,
+  get: function () {
+    return _joinBlocks.joinBlocks;
+  }
+});
 Object.defineProperty(exports, "lineBreak", {
   enumerable: true,
   get: function () {
@@ -60,18 +72,27 @@ Object.defineProperty(exports, "link", {
     return _inline.link;
   }
 });
+Object.defineProperty(exports, "list", {
+  enumerable: true,
+  get: function () {
+    return _block.list;
+  }
+});
 Object.defineProperty(exports, "orderedList", {
   enumerable: true,
   get: function () {
     return _block.orderedList;
   }
 });
-Object.defineProperty(exports, "unorderedList", {
+Object.defineProperty(exports, "table", {
   enumerable: true,
   get: function () {
-    return _block.unorderedList;
+    return _table.table;
   }
 });
+var _joinBlocks = require("./join-blocks.js");
 var _block = require("./block.js");
 var _inline = require("./inline.js");
+var _table = require("./table.js");
+var _html = require("./html.js");
 //# sourceMappingURL=index.js.map

package/dist/commonjs/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export {\n  horizontalRule,\n  heading,\n  blockquote,\n  orderedList,\n  unorderedList,\n  codeBlock,\n} from './block';\nexport { lineBreak, code, italic, bold, link, image } from './inline';\n"],"mappings":"","ignoreList":[]}
+{"version":3,"file":"index.js","names":[],"sources":["../../src/index.ts"],"sourcesContent":["export { joinBlocks } from './join-blocks';\nexport { horizontalRule, heading, blockquote, orderedList, list, codeBlock } from './block';\nexport { lineBreak, code, italic, bold, link, image } from './inline';\nexport { table } from './table';\nexport { disclosure } from './html';\n\nexport type { TableOptions } from './table';\n"],"mappings":"","ignoreList":[]}

package/dist/commonjs/inline.js.map

@@ -1 +1 @@
-{"version":3,"file":"inline.js","names":["lineBreak","exports","italic","text","bold","code","link","url","image"],"sources":["../../src/inline.ts"],"sourcesContent":["// Ref: https://www.markdownguide.org/basic-syntax/\n\nexport const lineBreak = '  \\n';\n\nexport function italic(text: string): string {\n  return `*${text}*`;\n}\n\nexport function bold(text: string): string {\n  return `**${text}**`;\n}\n\nexport function code(text: string): string {\n  return `\\`${text}\\``;\n}\n\nexport function link(url: string, text?: string): string {\n  return text ? `[${text}](${url})` : `<${url}>`;\n}\n\nexport function image(url: string, text?: string): string {\n  return `![${text ?? ''}](${url})`;\n}\n"],"mappings":";;;;;;;;AAEO,MAAMA,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,MAAM;AAExB,SAASE,MAAMA,CAACC,IAAY,EAAU;EAC3C,OAAO,IAAIA,IAAI,GAAG;AACpB;AAEO,SAASC,IAAIA,CAACD,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AAEO,SAASE,IAAIA,CAACF,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AAEO,SAASG,IAAIA,CAACC,GAAW,EAAEJ,IAAa,EAAU;EACvD,OAAOA,IAAI,GAAG,IAAIA,IAAI,KAAKI,GAAG,GAAG,GAAG,IAAIA,GAAG,GAAG;AAChD;AAEO,SAASC,KAAKA,CAACD,GAAW,EAAEJ,IAAa,EAAU;EACxD,OAAO,KAAKA,IAAI,IAAI,EAAE,KAAKI,GAAG,GAAG;AACnC","ignoreList":[]}
+{"version":3,"file":"inline.js","names":["lineBreak","exports","italic","text","bold","code","link","url","image"],"sources":["../../src/inline.ts"],"sourcesContent":["/**\n * Create a line break.\n *\n * Markdown: `__\\n`\n */\nexport const lineBreak = '  \\n';\n\n/**\n * Create an italic text.\n *\n * Markdown: `*text*`\n *\n * @param text - The text to be italicized.\n */\nexport function italic(text: string): string {\n  return `*${text}*`;\n}\n\n/**\n * Create a bold text.\n *\n * Markdown: `**text**`\n *\n * @param text - The text to be bolded.\n */\nexport function bold(text: string): string {\n  return `**${text}**`;\n}\n\n/**\n * Create a code text.\n *\n * Markdown: `\\`text\\``\n *\n * @param text - The text to be marked as code.\n */\nexport function code(text: string): string {\n  return `\\`${text}\\``;\n}\n\n/**\n * Create a link or autolink span.\n *\n * Markdown:\n * - `[text](url)` link when `text` is provided\n * - `<url>` autolink when `text` is not provided\n *\n * @param url - The URL to be linked.\n * @param text - The title for the link (optional).\n */\nexport function link(url: string, text?: string): string {\n  return text ? `[${text}](${url})` : `<${url}>`;\n}\n\n/**\n * Create an image text.\n *\n * Markdown: `![text](url)`\n *\n * @param url - The URL of the image.\n * @param text - The description for the image (optional).\n */\nexport function image(url: string, text?: string): string {\n  return `![${text ?? ''}](${url})`;\n}\n"],"mappings":";;;;;;;;AAKO,MAAMA,SAAS,GAAAC,OAAA,CAAAD,SAAA,GAAG,MAAM;AASxB,SAASE,MAAMA,CAACC,IAAY,EAAU;EAC3C,OAAO,IAAIA,IAAI,GAAG;AACpB;AASO,SAASC,IAAIA,CAACD,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AASO,SAASE,IAAIA,CAACF,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AAYO,SAASG,IAAIA,CAACC,GAAW,EAAEJ,IAAa,EAAU;EACvD,OAAOA,IAAI,GAAG,IAAIA,IAAI,KAAKI,GAAG,GAAG,GAAG,IAAIA,GAAG,GAAG;AAChD;AAUO,SAASC,KAAKA,CAACD,GAAW,EAAEJ,IAAa,EAAU;EACxD,OAAO,KAAKA,IAAI,IAAI,EAAE,KAAKI,GAAG,GAAG;AACnC","ignoreList":[]}

package/dist/commonjs/join-blocks.js

@@ -0,0 +1,10 @@
+"use strict";
+
+exports.joinBlocks = joinBlocks;
+function joinBlocks(blocks) {
+  return blocks.map(trimBlock).join('\n\n');
+}
+function trimBlock(block) {
+  return block.replace(/^\n+|\n+$/g, '');
+}
+//# sourceMappingURL=join-blocks.js.map

package/dist/commonjs/join-blocks.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"join-blocks.js","names":["joinBlocks","blocks","map","trimBlock","join","block","replace"],"sources":["../../src/join-blocks.ts"],"sourcesContent":["/**\n * Join blocks of text into a single markdown document (string).\n *\n * @param blocks - The blocks of text to join.\n * @returns Markdown document string.\n */\nexport function joinBlocks(blocks: string[]): string {\n  return blocks.map(trimBlock).join('\\n\\n');\n}\n\nfunction trimBlock(block: string): string {\n  return block.replace(/^\\n+|\\n+$/g, '');\n}\n"],"mappings":";;;AAMO,SAASA,UAAUA,CAACC,MAAgB,EAAU;EACnD,OAAOA,MAAM,CAACC,GAAG,CAACC,SAAS,CAAC,CAACC,IAAI,CAAC,MAAM,CAAC;AAC3C;AAEA,SAASD,SAASA,CAACE,KAAa,EAAU;EACxC,OAAOA,KAAK,CAACC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;AACxC","ignoreList":[]}

package/dist/commonjs/table.js

@@ -0,0 +1,27 @@
+"use strict";
+
+exports.table = table;
+function table(header, rows, options) {
+  if (header.length === 0) {
+    return '';
+  }
+  header = header.map(escapeCellContent);
+  rows = rows.map(row => row.map(escapeCellContent));
+  const widths = !options?.compact ? getColumnsWidth(header, rows) : header.map(() => 1);
+  const separators = header.map((_, i) => '-'.repeat(widths[i] ?? 0));
+  return [renderRow(header, widths), renderRow(separators, widths), ...rows.map(row => renderRow(row, widths))].join('\n');
+}
+function getColumnsWidth(header, rows) {
+  return header.map((_, index) => getColumnWidth(header, rows, index));
+}
+function getColumnWidth(header, rows, index) {
+  return Math.max(header[index]?.length ?? 0, ...rows.map(row => row[index]?.length ?? 0));
+}
+function renderRow(row, widths) {
+  const paddedCells = row.map((cell, index) => cell.padEnd(widths[index] ?? 0));
+  return `| ${paddedCells.join(' | ')} |`;
+}
+function escapeCellContent(cell) {
+  return cell.replace(/\|/g, '\\|').replace(/\n/g, '<br/>');
+}
+//# sourceMappingURL=table.js.map

package/dist/commonjs/table.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.js","names":["table","header","rows","options","length","map","escapeCellContent","row","widths","compact","getColumnsWidth","separators","_","i","repeat","renderRow","join","index","getColumnWidth","Math","max","paddedCells","cell","padEnd","replace"],"sources":["../../src/table.ts"],"sourcesContent":["export type TableOptions = {\n  compact: boolean;\n};\n\nexport function table(header: string[], rows: string[][], options?: TableOptions): string {\n  if (header.length === 0) {\n    return '';\n  }\n\n  // Escape the header and rows content\n  header = header.map(escapeCellContent);\n  rows = rows.map((row) => row.map(escapeCellContent));\n\n  const widths = !options?.compact ? getColumnsWidth(header, rows) : header.map(() => 1);\n  const separators = header.map((_, i) => '-'.repeat(widths[i] ?? 0));\n\n  return [\n    renderRow(header, widths),\n    renderRow(separators, widths),\n    ...rows.map((row) => renderRow(row, widths)),\n  ].join('\\n');\n}\n\nfunction getColumnsWidth(header: string[], rows: string[][]): number[] {\n  return header.map((_, index) => getColumnWidth(header, rows, index));\n}\n\nfunction getColumnWidth(header: string[], rows: string[][], index: number): number {\n  return Math.max(header[index]?.length ?? 0, ...rows.map((row) => row[index]?.length ?? 0));\n}\n\nfunction renderRow(row: string[], widths: number[]): string {\n  const paddedCells = row.map((cell, index) => cell.padEnd(widths[index] ?? 0));\n  return `| ${paddedCells.join(' | ')} |`;\n}\n\nfunction escapeCellContent(cell: string): string {\n  return cell.replace(/\\|/g, '\\\\|').replace(/\\n/g, '<br/>');\n}\n"],"mappings":";;;AAIO,SAASA,KAAKA,CAACC,MAAgB,EAAEC,IAAgB,EAAEC,OAAsB,EAAU;EACxF,IAAIF,MAAM,CAACG,MAAM,KAAK,CAAC,EAAE;IACvB,OAAO,EAAE;EACX;EAGAH,MAAM,GAAGA,MAAM,CAACI,GAAG,CAACC,iBAAiB,CAAC;EACtCJ,IAAI,GAAGA,IAAI,CAACG,GAAG,CAAEE,GAAG,IAAKA,GAAG,CAACF,GAAG,CAACC,iBAAiB,CAAC,CAAC;EAEpD,MAAME,MAAM,GAAG,CAACL,OAAO,EAAEM,OAAO,GAAGC,eAAe,CAACT,MAAM,EAAEC,IAAI,CAAC,GAAGD,MAAM,CAACI,GAAG,CAAC,MAAM,CAAC,CAAC;EACtF,MAAMM,UAAU,GAAGV,MAAM,CAACI,GAAG,CAAC,CAACO,CAAC,EAAEC,CAAC,KAAK,GAAG,CAACC,MAAM,CAACN,MAAM,CAACK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;EAEnE,OAAO,CACLE,SAAS,CAACd,MAAM,EAAEO,MAAM,CAAC,EACzBO,SAAS,CAACJ,UAAU,EAAEH,MAAM,CAAC,EAC7B,GAAGN,IAAI,CAACG,GAAG,CAAEE,GAAG,IAAKQ,SAAS,CAACR,GAAG,EAAEC,MAAM,CAAC,CAAC,CAC7C,CAACQ,IAAI,CAAC,IAAI,CAAC;AACd;AAEA,SAASN,eAAeA,CAACT,MAAgB,EAAEC,IAAgB,EAAY;EACrE,OAAOD,MAAM,CAACI,GAAG,CAAC,CAACO,CAAC,EAAEK,KAAK,KAAKC,cAAc,CAACjB,MAAM,EAAEC,IAAI,EAAEe,KAAK,CAAC,CAAC;AACtE;AAEA,SAASC,cAAcA,CAACjB,MAAgB,EAAEC,IAAgB,EAAEe,KAAa,EAAU;EACjF,OAAOE,IAAI,CAACC,GAAG,CAACnB,MAAM,CAACgB,KAAK,CAAC,EAAEb,MAAM,IAAI,CAAC,EAAE,GAAGF,IAAI,CAACG,GAAG,CAAEE,GAAG,IAAKA,GAAG,CAACU,KAAK,CAAC,EAAEb,MAAM,IAAI,CAAC,CAAC,CAAC;AAC5F;AAEA,SAASW,SAASA,CAACR,GAAa,EAAEC,MAAgB,EAAU;EAC1D,MAAMa,WAAW,GAAGd,GAAG,CAACF,GAAG,CAAC,CAACiB,IAAI,EAAEL,KAAK,KAAKK,IAAI,CAACC,MAAM,CAACf,MAAM,CAACS,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;EAC7E,OAAO,KAAKI,WAAW,CAACL,IAAI,CAAC,KAAK,CAAC,IAAI;AACzC;AAEA,SAASV,iBAAiBA,CAACgB,IAAY,EAAU;EAC/C,OAAOA,IAAI,CAACE,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAACA,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC;AAC3D","ignoreList":[]}

package/dist/esm/block.mjs

@@ -3,16 +3,16 @@ export const horizontalRule = '\n---\n';
 export function heading(text, level = 1) {
   return `${'#'.repeat(level)} ${text}`;
 }
-export function blockquote(text) {
-  return prefixLines(text, '> ');
+export function blockquote(content) {
+  return prefixLines(content, '> ');
 }
-export function codeBlock(text) {
-  return `\`\`\`\n${text}\n\`\`\``;
+export function codeBlock(content) {
+  return `\`\`\`\n${content}\n\`\`\``;
+}
+export function list(items) {
+  return items.map(item => `- ${item}`).join('\n');
 }
 export function orderedList(items) {
   return items.map((item, index) => `${index + 1}. ${item}`).join('\n');
 }
-export function unorderedList(items) {
-  return items.map(item => `- ${item}`).join('\n');
-}
 //# sourceMappingURL=block.mjs.map

package/dist/esm/block.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"block.mjs","names":["prefixLines","horizontalRule","heading","text","level","repeat","blockquote","codeBlock","orderedList","items","map","item","index","join","unorderedList"],"sources":["../../src/block.ts"],"sourcesContent":["import { prefixLines } from './utils';\n\n// Ref: https://www.markdownguide.org/basic-syntax/\n\nexport const horizontalRule = '\\n---\\n';\n\nexport function heading(text: string, level: number = 1): string {\n  return `${'#'.repeat(level)} ${text}`;\n}\n\nexport function blockquote(text: string): string {\n  return prefixLines(text, '> ');\n}\n\nexport function codeBlock(text: string): string {\n  return `\\`\\`\\`\\n${text}\\n\\`\\`\\``;\n}\n\nexport function orderedList(items: string[]): string {\n  return items.map((item, index) => `${index + 1}. ${item}`).join('\\n');\n}\n\nexport function unorderedList(items: string[]): string {\n  return items.map((item) => `- ${item}`).join('\\n');\n}\n"],"mappings":"SAASA,WAAW;AAIpB,OAAO,MAAMC,cAAc,GAAG,SAAS;AAEvC,OAAO,SAASC,OAAOA,CAACC,IAAY,EAAEC,KAAa,GAAG,CAAC,EAAU;EAC/D,OAAO,GAAG,GAAG,CAACC,MAAM,CAACD,KAAK,CAAC,IAAID,IAAI,EAAE;AACvC;AAEA,OAAO,SAASG,UAAUA,CAACH,IAAY,EAAU;EAC/C,OAAOH,WAAW,CAACG,IAAI,EAAE,IAAI,CAAC;AAChC;AAEA,OAAO,SAASI,SAASA,CAACJ,IAAY,EAAU;EAC9C,OAAO,WAAWA,IAAI,UAAU;AAClC;AAEA,OAAO,SAASK,WAAWA,CAACC,KAAe,EAAU;EACnD,OAAOA,KAAK,CAACC,GAAG,CAAC,CAACC,IAAI,EAAEC,KAAK,KAAK,GAAGA,KAAK,GAAG,CAAC,KAAKD,IAAI,EAAE,CAAC,CAACE,IAAI,CAAC,IAAI,CAAC;AACvE;AAEA,OAAO,SAASC,aAAaA,CAACL,KAAe,EAAU;EACrD,OAAOA,KAAK,CAACC,GAAG,CAAEC,IAAI,IAAK,KAAKA,IAAI,EAAE,CAAC,CAACE,IAAI,CAAC,IAAI,CAAC;AACpD","ignoreList":[]}
+{"version":3,"file":"block.mjs","names":["prefixLines","horizontalRule","heading","text","level","repeat","blockquote","content","codeBlock","list","items","map","item","join","orderedList","index"],"sources":["../../src/block.ts"],"sourcesContent":["import { prefixLines } from './utils';\n\n/**\n * Create a horizontal rule block.\n *\n * Markdown: `---`\n */\nexport const horizontalRule = '\\n---\\n';\n\n/**\n * Create a heading block.\n * Markdown: `# Heading`\n *\n * @param text - The text of the heading.\n * @param level - The level of the heading (defaults to 1).\n */\nexport function heading(text: string, level: number = 1): string {\n  return `${'#'.repeat(level)} ${text}`;\n}\n\n/**\n * Create a blockquote block.\n *\n * Markdown:\n * ```\n * > Content\n * > Content\n * ```\n *\n * @param text - The content of the blockquote.\n */\nexport function blockquote(content: string): string {\n  return prefixLines(content, '> ');\n}\n\n/**\n * Create a code block.\n *\n * Markdown:\n * ````\n * ```\n * Content\n * ```\n * ````\n *\n * @param content - The content of the code block.\n */\nexport function codeBlock(content: string): string {\n  return `\\`\\`\\`\\n${content}\\n\\`\\`\\``;\n}\n\n/**\n * Create an unordered list block.\n *\n * Markdown:\n * ```\n * - Item\n * - Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function list(items: string[]): string {\n  return items.map((item) => `- ${item}`).join('\\n');\n}\n\n/**\n * Create an ordered list block.\n *\n * Markdown:\n * ```\n * 1. Item\n * 2. Item\n * ```\n *\n * @param items - The items of the list.\n */\nexport function orderedList(items: string[]): string {\n  return items.map((item, index) => `${index + 1}. ${item}`).join('\\n');\n}\n"],"mappings":"SAASA,WAAW;AAOpB,OAAO,MAAMC,cAAc,GAAG,SAAS;AASvC,OAAO,SAASC,OAAOA,CAACC,IAAY,EAAEC,KAAa,GAAG,CAAC,EAAU;EAC/D,OAAO,GAAG,GAAG,CAACC,MAAM,CAACD,KAAK,CAAC,IAAID,IAAI,EAAE;AACvC;AAaA,OAAO,SAASG,UAAUA,CAACC,OAAe,EAAU;EAClD,OAAOP,WAAW,CAACO,OAAO,EAAE,IAAI,CAAC;AACnC;AAcA,OAAO,SAASC,SAASA,CAACD,OAAe,EAAU;EACjD,OAAO,WAAWA,OAAO,UAAU;AACrC;AAaA,OAAO,SAASE,IAAIA,CAACC,KAAe,EAAU;EAC5C,OAAOA,KAAK,CAACC,GAAG,CAAEC,IAAI,IAAK,KAAKA,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACpD;AAaA,OAAO,SAASC,WAAWA,CAACJ,KAAe,EAAU;EACnD,OAAOA,KAAK,CAACC,GAAG,CAAC,CAACC,IAAI,EAAEG,KAAK,KAAK,GAAGA,KAAK,GAAG,CAAC,KAAKH,IAAI,EAAE,CAAC,CAACC,IAAI,CAAC,IAAI,CAAC;AACvE","ignoreList":[]}

package/dist/esm/html.mjs

@@ -0,0 +1,4 @@
+export function disclosure(title, content) {
+  return `<details>\n<summary>${title}</summary>\n${content}\n</details>`;
+}
+//# sourceMappingURL=html.mjs.map

package/dist/esm/html.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"html.mjs","names":["disclosure","title","content"],"sources":["../../src/html.ts"],"sourcesContent":["/**\n * Create a disclosure block.\n *\n * Markdown/Html:\n * ```\n * <details>\n *   <summary>Title</summary>\n *   Content\n * </details>\n * ```\n *\n * @param title - The title of the disclosure.\n * @param content - The content of the disclosure.\n */\nexport function disclosure(title: string, content: string): string {\n  return `<details>\\n<summary>${title}</summary>\\n${content}\\n</details>`;\n}\n"],"mappings":"AAcA,OAAO,SAASA,UAAUA,CAACC,KAAa,EAAEC,OAAe,EAAU;EACjE,OAAO,uBAAuBD,KAAK,eAAeC,OAAO,cAAc;AACzE","ignoreList":[]}

package/dist/esm/index.mjs

@@ -1,3 +1,6 @@
-export { horizontalRule, heading, blockquote, orderedList, unorderedList, codeBlock } from "./block.mjs";
+export { joinBlocks } from "./join-blocks.mjs";
+export { horizontalRule, heading, blockquote, orderedList, list, codeBlock } from "./block.mjs";
 export { lineBreak, code, italic, bold, link, image } from "./inline.mjs";
+export { table } from "./table.mjs";
+export { disclosure } from "./html.mjs";
 //# sourceMappingURL=index.mjs.map

package/dist/esm/index.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"index.mjs","names":["horizontalRule","heading","blockquote","orderedList","unorderedList","codeBlock","lineBreak","code","italic","bold","link","image"],"sources":["../../src/index.ts"],"sourcesContent":["export {\n  horizontalRule,\n  heading,\n  blockquote,\n  orderedList,\n  unorderedList,\n  codeBlock,\n} from './block';\nexport { lineBreak, code, italic, bold, link, image } from './inline';\n"],"mappings":"SACEA,cAAc,EACdC,OAAO,EACPC,UAAU,EACVC,WAAW,EACXC,aAAa,EACbC,SAAS;AAAA,SAEFC,SAAS,EAAEC,IAAI,EAAEC,MAAM,EAAEC,IAAI,EAAEC,IAAI,EAAEC,KAAK","ignoreList":[]}
+{"version":3,"file":"index.mjs","names":["joinBlocks","horizontalRule","heading","blockquote","orderedList","list","codeBlock","lineBreak","code","italic","bold","link","image","table","disclosure"],"sources":["../../src/index.ts"],"sourcesContent":["export { joinBlocks } from './join-blocks';\nexport { horizontalRule, heading, blockquote, orderedList, list, codeBlock } from './block';\nexport { lineBreak, code, italic, bold, link, image } from './inline';\nexport { table } from './table';\nexport { disclosure } from './html';\n\nexport type { TableOptions } from './table';\n"],"mappings":"SAASA,UAAU;AAAA,SACVC,cAAc,EAAEC,OAAO,EAAEC,UAAU,EAAEC,WAAW,EAAEC,IAAI,EAAEC,SAAS;AAAA,SACjEC,SAAS,EAAEC,IAAI,EAAEC,MAAM,EAAEC,IAAI,EAAEC,IAAI,EAAEC,KAAK;AAAA,SAC1CC,KAAK;AAAA,SACLC,UAAU","ignoreList":[]}

package/dist/esm/inline.mjs.map

@@ -1 +1 @@
-{"version":3,"file":"inline.mjs","names":["lineBreak","italic","text","bold","code","link","url","image"],"sources":["../../src/inline.ts"],"sourcesContent":["// Ref: https://www.markdownguide.org/basic-syntax/\n\nexport const lineBreak = '  \\n';\n\nexport function italic(text: string): string {\n  return `*${text}*`;\n}\n\nexport function bold(text: string): string {\n  return `**${text}**`;\n}\n\nexport function code(text: string): string {\n  return `\\`${text}\\``;\n}\n\nexport function link(url: string, text?: string): string {\n  return text ? `[${text}](${url})` : `<${url}>`;\n}\n\nexport function image(url: string, text?: string): string {\n  return `![${text ?? ''}](${url})`;\n}\n"],"mappings":"AAEA,OAAO,MAAMA,SAAS,GAAG,MAAM;AAE/B,OAAO,SAASC,MAAMA,CAACC,IAAY,EAAU;EAC3C,OAAO,IAAIA,IAAI,GAAG;AACpB;AAEA,OAAO,SAASC,IAAIA,CAACD,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AAEA,OAAO,SAASE,IAAIA,CAACF,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AAEA,OAAO,SAASG,IAAIA,CAACC,GAAW,EAAEJ,IAAa,EAAU;EACvD,OAAOA,IAAI,GAAG,IAAIA,IAAI,KAAKI,GAAG,GAAG,GAAG,IAAIA,GAAG,GAAG;AAChD;AAEA,OAAO,SAASC,KAAKA,CAACD,GAAW,EAAEJ,IAAa,EAAU;EACxD,OAAO,KAAKA,IAAI,IAAI,EAAE,KAAKI,GAAG,GAAG;AACnC","ignoreList":[]}
+{"version":3,"file":"inline.mjs","names":["lineBreak","italic","text","bold","code","link","url","image"],"sources":["../../src/inline.ts"],"sourcesContent":["/**\n * Create a line break.\n *\n * Markdown: `__\\n`\n */\nexport const lineBreak = '  \\n';\n\n/**\n * Create an italic text.\n *\n * Markdown: `*text*`\n *\n * @param text - The text to be italicized.\n */\nexport function italic(text: string): string {\n  return `*${text}*`;\n}\n\n/**\n * Create a bold text.\n *\n * Markdown: `**text**`\n *\n * @param text - The text to be bolded.\n */\nexport function bold(text: string): string {\n  return `**${text}**`;\n}\n\n/**\n * Create a code text.\n *\n * Markdown: `\\`text\\``\n *\n * @param text - The text to be marked as code.\n */\nexport function code(text: string): string {\n  return `\\`${text}\\``;\n}\n\n/**\n * Create a link or autolink span.\n *\n * Markdown:\n * - `[text](url)` link when `text` is provided\n * - `<url>` autolink when `text` is not provided\n *\n * @param url - The URL to be linked.\n * @param text - The title for the link (optional).\n */\nexport function link(url: string, text?: string): string {\n  return text ? `[${text}](${url})` : `<${url}>`;\n}\n\n/**\n * Create an image text.\n *\n * Markdown: `![text](url)`\n *\n * @param url - The URL of the image.\n * @param text - The description for the image (optional).\n */\nexport function image(url: string, text?: string): string {\n  return `![${text ?? ''}](${url})`;\n}\n"],"mappings":"AAKA,OAAO,MAAMA,SAAS,GAAG,MAAM;AAS/B,OAAO,SAASC,MAAMA,CAACC,IAAY,EAAU;EAC3C,OAAO,IAAIA,IAAI,GAAG;AACpB;AASA,OAAO,SAASC,IAAIA,CAACD,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AASA,OAAO,SAASE,IAAIA,CAACF,IAAY,EAAU;EACzC,OAAO,KAAKA,IAAI,IAAI;AACtB;AAYA,OAAO,SAASG,IAAIA,CAACC,GAAW,EAAEJ,IAAa,EAAU;EACvD,OAAOA,IAAI,GAAG,IAAIA,IAAI,KAAKI,GAAG,GAAG,GAAG,IAAIA,GAAG,GAAG;AAChD;AAUA,OAAO,SAASC,KAAKA,CAACD,GAAW,EAAEJ,IAAa,EAAU;EACxD,OAAO,KAAKA,IAAI,IAAI,EAAE,KAAKI,GAAG,GAAG;AACnC","ignoreList":[]}

package/dist/esm/join-blocks.mjs

@@ -0,0 +1,7 @@
+export function joinBlocks(blocks) {
+  return blocks.map(trimBlock).join('\n\n');
+}
+function trimBlock(block) {
+  return block.replace(/^\n+|\n+$/g, '');
+}
+//# sourceMappingURL=join-blocks.mjs.map

package/dist/esm/join-blocks.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"join-blocks.mjs","names":["joinBlocks","blocks","map","trimBlock","join","block","replace"],"sources":["../../src/join-blocks.ts"],"sourcesContent":["/**\n * Join blocks of text into a single markdown document (string).\n *\n * @param blocks - The blocks of text to join.\n * @returns Markdown document string.\n */\nexport function joinBlocks(blocks: string[]): string {\n  return blocks.map(trimBlock).join('\\n\\n');\n}\n\nfunction trimBlock(block: string): string {\n  return block.replace(/^\\n+|\\n+$/g, '');\n}\n"],"mappings":"AAMA,OAAO,SAASA,UAAUA,CAACC,MAAgB,EAAU;EACnD,OAAOA,MAAM,CAACC,GAAG,CAACC,SAAS,CAAC,CAACC,IAAI,CAAC,MAAM,CAAC;AAC3C;AAEA,SAASD,SAASA,CAACE,KAAa,EAAU;EACxC,OAAOA,KAAK,CAACC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC;AACxC","ignoreList":[]}

package/dist/esm/table.mjs

@@ -0,0 +1,24 @@
+export function table(header, rows, options) {
+  if (header.length === 0) {
+    return '';
+  }
+  header = header.map(escapeCellContent);
+  rows = rows.map(row => row.map(escapeCellContent));
+  const widths = !options?.compact ? getColumnsWidth(header, rows) : header.map(() => 1);
+  const separators = header.map((_, i) => '-'.repeat(widths[i] ?? 0));
+  return [renderRow(header, widths), renderRow(separators, widths), ...rows.map(row => renderRow(row, widths))].join('\n');
+}
+function getColumnsWidth(header, rows) {
+  return header.map((_, index) => getColumnWidth(header, rows, index));
+}
+function getColumnWidth(header, rows, index) {
+  return Math.max(header[index]?.length ?? 0, ...rows.map(row => row[index]?.length ?? 0));
+}
+function renderRow(row, widths) {
+  const paddedCells = row.map((cell, index) => cell.padEnd(widths[index] ?? 0));
+  return `| ${paddedCells.join(' | ')} |`;
+}
+function escapeCellContent(cell) {
+  return cell.replace(/\|/g, '\\|').replace(/\n/g, '<br/>');
+}
+//# sourceMappingURL=table.mjs.map

package/dist/esm/table.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"table.mjs","names":["table","header","rows","options","length","map","escapeCellContent","row","widths","compact","getColumnsWidth","separators","_","i","repeat","renderRow","join","index","getColumnWidth","Math","max","paddedCells","cell","padEnd","replace"],"sources":["../../src/table.ts"],"sourcesContent":["export type TableOptions = {\n  compact: boolean;\n};\n\nexport function table(header: string[], rows: string[][], options?: TableOptions): string {\n  if (header.length === 0) {\n    return '';\n  }\n\n  // Escape the header and rows content\n  header = header.map(escapeCellContent);\n  rows = rows.map((row) => row.map(escapeCellContent));\n\n  const widths = !options?.compact ? getColumnsWidth(header, rows) : header.map(() => 1);\n  const separators = header.map((_, i) => '-'.repeat(widths[i] ?? 0));\n\n  return [\n    renderRow(header, widths),\n    renderRow(separators, widths),\n    ...rows.map((row) => renderRow(row, widths)),\n  ].join('\\n');\n}\n\nfunction getColumnsWidth(header: string[], rows: string[][]): number[] {\n  return header.map((_, index) => getColumnWidth(header, rows, index));\n}\n\nfunction getColumnWidth(header: string[], rows: string[][], index: number): number {\n  return Math.max(header[index]?.length ?? 0, ...rows.map((row) => row[index]?.length ?? 0));\n}\n\nfunction renderRow(row: string[], widths: number[]): string {\n  const paddedCells = row.map((cell, index) => cell.padEnd(widths[index] ?? 0));\n  return `| ${paddedCells.join(' | ')} |`;\n}\n\nfunction escapeCellContent(cell: string): string {\n  return cell.replace(/\\|/g, '\\\\|').replace(/\\n/g, '<br/>');\n}\n"],"mappings":"AAIA,OAAO,SAASA,KAAKA,CAACC,MAAgB,EAAEC,IAAgB,EAAEC,OAAsB,EAAU;EACxF,IAAIF,MAAM,CAACG,MAAM,KAAK,CAAC,EAAE;IACvB,OAAO,EAAE;EACX;EAGAH,MAAM,GAAGA,MAAM,CAACI,GAAG,CAACC,iBAAiB,CAAC;EACtCJ,IAAI,GAAGA,IAAI,CAACG,GAAG,CAAEE,GAAG,IAAKA,GAAG,CAACF,GAAG,CAACC,iBAAiB,CAAC,CAAC;EAEpD,MAAME,MAAM,GAAG,CAACL,OAAO,EAAEM,OAAO,GAAGC,eAAe,CAACT,MAAM,EAAEC,IAAI,CAAC,GAAGD,MAAM,CAACI,GAAG,CAAC,MAAM,CAAC,CAAC;EACtF,MAAMM,UAAU,GAAGV,MAAM,CAACI,GAAG,CAAC,CAACO,CAAC,EAAEC,CAAC,KAAK,GAAG,CAACC,MAAM,CAACN,MAAM,CAACK,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC;EAEnE,OAAO,CACLE,SAAS,CAACd,MAAM,EAAEO,MAAM,CAAC,EACzBO,SAAS,CAACJ,UAAU,EAAEH,MAAM,CAAC,EAC7B,GAAGN,IAAI,CAACG,GAAG,CAAEE,GAAG,IAAKQ,SAAS,CAACR,GAAG,EAAEC,MAAM,CAAC,CAAC,CAC7C,CAACQ,IAAI,CAAC,IAAI,CAAC;AACd;AAEA,SAASN,eAAeA,CAACT,MAAgB,EAAEC,IAAgB,EAAY;EACrE,OAAOD,MAAM,CAACI,GAAG,CAAC,CAACO,CAAC,EAAEK,KAAK,KAAKC,cAAc,CAACjB,MAAM,EAAEC,IAAI,EAAEe,KAAK,CAAC,CAAC;AACtE;AAEA,SAASC,cAAcA,CAACjB,MAAgB,EAAEC,IAAgB,EAAEe,KAAa,EAAU;EACjF,OAAOE,IAAI,CAACC,GAAG,CAACnB,MAAM,CAACgB,KAAK,CAAC,EAAEb,MAAM,IAAI,CAAC,EAAE,GAAGF,IAAI,CAACG,GAAG,CAAEE,GAAG,IAAKA,GAAG,CAACU,KAAK,CAAC,EAAEb,MAAM,IAAI,CAAC,CAAC,CAAC;AAC5F;AAEA,SAASW,SAASA,CAACR,GAAa,EAAEC,MAAgB,EAAU;EAC1D,MAAMa,WAAW,GAAGd,GAAG,CAACF,GAAG,CAAC,CAACiB,IAAI,EAAEL,KAAK,KAAKK,IAAI,CAACC,MAAM,CAACf,MAAM,CAACS,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;EAC7E,OAAO,KAAKI,WAAW,CAACL,IAAI,CAAC,KAAK,CAAC,IAAI;AACzC;AAEA,SAASV,iBAAiBA,CAACgB,IAAY,EAAU;EAC/C,OAAOA,IAAI,CAACE,OAAO,CAAC,KAAK,EAAE,KAAK,CAAC,CAACA,OAAO,CAAC,KAAK,EAAE,OAAO,CAAC;AAC3D","ignoreList":[]}

package/dist/types/block.d.ts

@@ -1,6 +1,63 @@
+/**
+ * Create a horizontal rule block.
+ *
+ * Markdown: `---`
+ */
 export declare const horizontalRule = "\n---\n";
+/**
+ * Create a heading block.
+ * Markdown: `# Heading`
+ *
+ * @param text - The text of the heading.
+ * @param level - The level of the heading (defaults to 1).
+ */
 export declare function heading(text: string, level?: number): string;
-export declare function blockquote(text: string): string;
-export declare function codeBlock(text: string): string;
+/**
+ * Create a blockquote block.
+ *
+ * Markdown:
+ * ```
+ * > Content
+ * > Content
+ * ```
+ *
+ * @param text - The content of the blockquote.
+ */
+export declare function blockquote(content: string): string;
+/**
+ * Create a code block.
+ *
+ * Markdown:
+ * ````
+ * ```
+ * Content
+ * ```
+ * ````
+ *
+ * @param content - The content of the code block.
+ */
+export declare function codeBlock(content: string): string;
+/**
+ * Create an unordered list block.
+ *
+ * Markdown:
+ * ```
+ * - Item
+ * - Item
+ * ```
+ *
+ * @param items - The items of the list.
+ */
+export declare function list(items: string[]): string;
+/**
+ * Create an ordered list block.
+ *
+ * Markdown:
+ * ```
+ * 1. Item
+ * 2. Item
+ * ```
+ *
+ * @param items - The items of the list.
+ */
 export declare function orderedList(items: string[]): string;
-export declare function unorderedList(items: string[]): string;

package/dist/types/html.d.ts

@@ -0,0 +1,15 @@
+/**
+ * Create a disclosure block.
+ *
+ * Markdown/Html:
+ * ```
+ * <details>
+ *   <summary>Title</summary>
+ *   Content
+ * </details>
+ * ```
+ *
+ * @param title - The title of the disclosure.
+ * @param content - The content of the disclosure.
+ */
+export declare function disclosure(title: string, content: string): string;

package/dist/types/index.d.ts

@@ -1,2 +1,6 @@
-export { horizontalRule, heading, blockquote, orderedList, unorderedList, codeBlock, } from './block';
+export { joinBlocks } from './join-blocks';
+export { horizontalRule, heading, blockquote, orderedList, list, codeBlock } from './block';
 export { lineBreak, code, italic, bold, link, image } from './inline';
+export { table } from './table';
+export { disclosure } from './html';
+export type { TableOptions } from './table';

package/dist/types/inline.d.ts

@@ -1,6 +1,50 @@
+/**
+ * Create a line break.
+ *
+ * Markdown: `__\n`
+ */
 export declare const lineBreak = "  \n";
+/**
+ * Create an italic text.
+ *
+ * Markdown: `*text*`
+ *
+ * @param text - The text to be italicized.
+ */
 export declare function italic(text: string): string;
+/**
+ * Create a bold text.
+ *
+ * Markdown: `**text**`
+ *
+ * @param text - The text to be bolded.
+ */
 export declare function bold(text: string): string;
+/**
+ * Create a code text.
+ *
+ * Markdown: `\`text\``
+ *
+ * @param text - The text to be marked as code.
+ */
 export declare function code(text: string): string;
+/**
+ * Create a link or autolink span.
+ *
+ * Markdown:
+ * - `[text](url)` link when `text` is provided
+ * - `<url>` autolink when `text` is not provided
+ *
+ * @param url - The URL to be linked.
+ * @param text - The title for the link (optional).
+ */
 export declare function link(url: string, text?: string): string;
+/**
+ * Create an image text.
+ *
+ * Markdown: `![text](url)`
+ *
+ * @param url - The URL of the image.
+ * @param text - The description for the image (optional).
+ */
 export declare function image(url: string, text?: string): string;

package/dist/types/join-blocks.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Join blocks of text into a single markdown document (string).
+ *
+ * @param blocks - The blocks of text to join.
+ * @returns Markdown document string.
+ */
+export declare function joinBlocks(blocks: string[]): string;

package/dist/types/table.d.ts

@@ -0,0 +1,4 @@
+export type TableOptions = {
+    compact: boolean;
+};
+export declare function table(header: string[], rows: string[][], options?: TableOptions): string;

package/package.json

@@ -1,10 +1,10 @@
 {
   "name": "ts-markdown-builder",
-  "version": "0.1.0",
+  "version": "0.2.1",
   "description": "Elegant markdown builder with minimal bundle size.",
   "main": "dist/commonjs/index.js",
   "module": "dist/esm/index.mjs",
-  "types": "dist/types/src/index.d.ts",
+  "types": "dist/types/index.d.ts",
   "source": "src/index.ts",
   "sideEffects": false,
   "files": [

package/dist/commonjs/types.js

@@ -1,2 +0,0 @@
-"use strict";
-//# sourceMappingURL=types.js.map

package/dist/commonjs/types.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.js","names":[],"sources":["../../src/types.ts"],"sourcesContent":[""],"mappings":"","ignoreList":[]}

package/dist/esm/types.mjs

@@ -1,2 +0,0 @@
-
-//# sourceMappingURL=types.mjs.map

package/dist/esm/types.mjs.map

@@ -1 +0,0 @@
-{"version":3,"file":"types.mjs","names":[],"sources":["../../src/types.ts"],"sourcesContent":[""],"mappings":"","ignoreList":[]}