{"_id":"omark","_rev":"1-2cce7fc6926e03c7aafc6a8218d97e4e","name":"omark","dist-tags":{"latest":"0.1.0"},"versions":{"0.0.0":{"name":"omark","version":"0.0.0","_id":"omark@0.0.0","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-uxVMKsaGggVV4abguNchpU22uXusYQbbwqyuZVT5O1SpYmmHQF4fxXwYOlqve9fut+IDc80hurJi7dGgdz8H6w==","shasum":"928787c74401511961f51385ada15853e268bdb0","tarball":"https://registry.npmjs.org/omark/-/omark-0.0.0.tgz","fileCount":1,"unpackedSize":34,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIDmuCobKZJzBwQ1j+glQk9/EL3hmVD+esDW9oSeabrQNAiEAgA6nU2uwjBnOSJujMXMUvKL8zzjJYU1mkMGM9CxvmBo="}]},"_npmUser":{"name":"pi0","email":"pyapar@gmail.com"},"directories":{},"maintainers":[{"name":"pi0","email":"pyapar@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/omark_0.0.0_1707214547514_0.02197130835914085"},"_hasShrinkwrap":false},"0.1.0":{"name":"omark","version":"0.1.0","description":"Just simple markdown utils!","repository":{"type":"git","url":"git+https://github.com/unjs/omark.git"},"license":"MIT","sideEffects":false,"type":"module","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.mjs","require":"./dist/index.cjs"}},"main":"./dist/index.cjs","module":"./dist/index.mjs","types":"./dist/index.d.ts","scripts":{"build":"automd && unbuild","dev":"vitest dev","lint":"eslint --cache --ext .ts,.js,.mjs,.cjs . && prettier -c src test","lint:fix":"eslint --cache --ext .ts,.js,.mjs,.cjs . --fix && prettier -c src test -w","prepack":"pnpm build","play":"jiti playground","release":"pnpm test && changelogen --release && npm publish && git push --follow-tags","test":"pnpm lint && pnpm test:types && vitest run --coverage","test:types":"tsc --noEmit --skipLibCheck"},"devDependencies":{"@types/node":"^20.11.6","@vitest/coverage-v8":"^1.2.1","automd":"^0.1.1","changelogen":"^0.5.5","eslint":"^8.56.0","eslint-config-unjs":"^0.2.1","jiti":"^1.21.0","prettier":"^3.1.1","typescript":"^5.3.3","unbuild":"^2.0.0","vitest":"^1.1.0"},"packageManager":"pnpm@8.12.1","_id":"omark@0.1.0","gitHead":"7141472a7dad3f6232c6935d4a3a70d1f61e3591","bugs":{"url":"https://github.com/unjs/omark/issues"},"homepage":"https://github.com/unjs/omark#readme","_nodeVersion":"20.11.0","_npmVersion":"10.2.4","dist":{"integrity":"sha512-l+7hOfsjru88QuW7E937KH7BSz99NownkNTGigi+e4JzeSSCosMp2v3eVW1wdmgm99pFbzaUVg1kiT2V0QvvtQ==","shasum":"ee63bc1e27b100077b928313e949ec4069b278b1","tarball":"https://registry.npmjs.org/omark/-/omark-0.1.0.tgz","fileCount":8,"unpackedSize":26856,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHHJ/wXV+aqPFeA/5GZpvfSTRX6OkpqFLIuSP1pEpntDAiEA7ifkCNyCimhmBh1gUeRXkgR7aqgzeXUKvLtfRpHpSiA="}]},"_npmUser":{"name":"pi0","email":"pyapar@gmail.com"},"directories":{},"maintainers":[{"name":"pi0","email":"pyapar@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/omark_0.1.0_1707217934144_0.033718155250128445"},"_hasShrinkwrap":false}},"time":{"created":"2024-02-06T10:15:47.513Z","0.0.0":"2024-02-06T10:15:47.640Z","modified":"2024-02-06T11:12:14.506Z","0.1.0":"2024-02-06T11:12:14.308Z"},"maintainers":[{"name":"pi0","email":"pyapar@gmail.com"}],"readme":"# ⬇️ omark\n\n[![npm version][npm-version-src]][npm-version-href]\n[![npm downloads][npm-downloads-src]][npm-downloads-href]\n\n<!-- [![bundle][bundle-src]][bundle-href] -->\n<!-- [![Codecov][codecov-src]][codecov-href] -->\n\nJust simple markdown utils!\n\n> [!NOTE]\n> This project is under development and i am colleting more utils across my projects to here.\n\n## Usage\n\nInstall package:\n\n```sh\n# npm\nnpm install omark\n\n# yarn\nyarn add omark\n\n# pnpm\npnpm install omark\n\n# bun\nbun install omark\n```\n\nImport:\n\n```js\n// ESM\nimport { md } from \"omark\";\n\n// CommonJS\nconst { md } = require(\"omark\");\n```\n\n## Utils\n\n<!-- AUTOMD_START generator=\"jsdocs\" -->\n\n### Render\n\n#### `blockquote(text)`\n\nRender a markdown blockquote text with > in front of a paragraph\n\n**Example:**\n\n```js\nmd.blockquote('Hello, World!');\n// => \"> Hello, World!\"\n```\n\n#### `bold(text)`\n\nRender a markdown bold text.\n\n**Example:**\n\n```js\nmd.bold('Hello, World!');\n// => \"**Hello, World!**\"\n```\n\n#### `boldAndItalic(text)`\n\nRender a markdown bold and italic text.\n\n**Example:**\n\n```js\nmd.bold('Hello, World!');\n// => \"***Hello, World!***\"\n```\n\n#### `codeBlock(code, lang, opts)`\n\nFormat a string as a code block.\n\n**Example:**\n\n```js\nmd.codeBlock('console.log(\"Hello, World!\");', 'js');\n// => \"```js\\nconsole.log(\"Hello, World!\");\\n```\"\n```\n\n#### `heading(text, level)`\n\nRender a markdown heading.\n\n**Example:**\n\n```js\nmd.heading(1, 'Hello, World!');\n// => \"\\n# Hello, World!\\n\"\n```\n\n#### `hr(length)`\n\nRender a markdown horizontal rule.\n\n**Example:**\n\n```js\nmd.hr();\n// => \"---\"\n```\n\n#### `image(url, text, opts)`\n\nRender a markdown image.\n\n**Example:**\n\n```js\nmd.image('https://cataas.com/cat', 'Cute Cat');\n// => \"![Cute Cat](https://cataas.com/cat)\"\n```\n\n#### `italic(text)`\n\nRender a markdown italic text.\n\n**Example:**\n\n```js\nmd.bold('Hello, World!');\n// => \"_Hello, World!_\"\n```\n\n#### `link(url, text, opts)`\n\nRender a markdown link.\n\n**Example:**\n\n```js\n md.link('Google', 'https://www.google.com');\n // => \"[Google](https://www.google.com)\"\n```\n```js\nmd.link('https://www.google.com', 'Google', { external: true });\n// => \"<a href=\"https://www.google.com\" title=\"Google\" target=\"_blank\">Google</a>\"\n```\n\n#### `list(items, opts)`\n\nRender a markdown ordered or unordered list.\n\n**Example:**\n\n```js\nmd.list(['Item 1', 'Item 2', 'Item 3']);\n// => \"- Item 1\\n- Item 2\\n- Item 3\"\n```\n\n#### `strikethrough(text)`\n\nRender a markdown strikethrough text.\n\n**Example:**\n\n```js\nmd.strikethrough('Hello, World!');\n// => \"~~Hello, World!~~\"\n```\n\n#### `table(table)`\n\nRender a markdown table.\n\n**Example:**\n\n```js\nmd.table({\n columns: [\"Breed\", \"Origin\", \"Size\", \"Temperament\"],\n rows: [\n   [\"Abyssinian\", \"Egypt\", \"Medium\", \"Active\"],\n   [\"Aegean\", \"Greece\", \"Medium\", \"Active\"],\n   [\"American Bobtail\", \"United States\", \"Medium\", \"Active\"],\n   [\"Applehead Siamese\", \"Thailand\", \"Medium\", \"Active\"],\n  ],\n});\n```\n\n\n<!-- AUTOMD_END -->\n\n## Development\n\n- Clone this repository\n- Install latest LTS version of [Node.js](https://nodejs.org/en/)\n- Enable [Corepack](https://github.com/nodejs/corepack) using `corepack enable`\n- Install dependencies using `pnpm install`\n- Run interactive tests using `pnpm dev`\n\n## License\n\nMade with 💛\n\nPublished under [MIT License](./LICENSE).\n\n<!-- Badges -->\n\n[npm-version-src]: https://img.shields.io/npm/v/omark?style=flat&colorA=18181B&colorB=F0DB4F\n[npm-version-href]: https://npmjs.com/package/omark\n[npm-downloads-src]: https://img.shields.io/npm/dm/omark?style=flat&colorA=18181B&colorB=F0DB4F\n[npm-downloads-href]: https://npmjs.com/package/omark\n\n<!-- [codecov-src]: https://img.shields.io/codecov/c/gh/unjs/omark/main?style=flat&colorA=18181B&colorB=F0DB4F\n[codecov-href]: https://codecov.io/gh/unjs/omark\n\n[bundle-src]: https://img.shields.io/bundlephobia/minzip/omark?style=flat&colorA=18181B&colorB=F0DB4F\n[bundle-href]: https://bundlephobia.com/result?p=omark -->\n","readmeFilename":"README.md","description":"Just simple markdown utils!","homepage":"https://github.com/unjs/omark#readme","repository":{"type":"git","url":"git+https://github.com/unjs/omark.git"},"bugs":{"url":"https://github.com/unjs/omark/issues"},"license":"MIT"}