{"_id":"marked-plaintify","_rev":"3-db38d77cac50eb9fe78a6b01d914fe6a","name":"marked-plaintify","dist-tags":{"latest":"1.1.1"},"versions":{"1.0.0":{"name":"marked-plaintify","version":"1.0.0","keywords":["marked","marked-extension","markdown","plaintext","text","document","strip","nlp","stilearning-marked-extensions"],"author":{"url":"https://stilearning.com","name":"Beni Arisandi"},"license":"MIT","_id":"marked-plaintify@1.0.0","maintainers":[{"name":"bent10","email":"bent10@stilearning.com"}],"homepage":"https://github.com/bent10/marked-extensions/tree/main/packages/plaintify","bugs":{"url":"https://github.com/bent10/marked-extensions/issues"},"dist":{"shasum":"f703b3627d44d88771c20779e1acff96424ca63b","tarball":"https://registry.npmjs.org/marked-plaintify/-/marked-plaintify-1.0.0.tgz","fileCount":7,"integrity":"sha512-l2UMnjcQZZWB3Bx6SnOWVOSJ8LP5GFjjypHdozlg4WynYadMLZoXyhLNioeJ4cpN6CfYDGmoNwsuZvqMiFtlJw==","signatures":[{"sig":"MEUCIQD8rq7rhcIGx1jerrTwpO9oU+WT2DSAM7QG05rLZfAgCwIgRRVWB+ab4xd+FWfEm77eE1aClrZuTUmLMbpj8fVZv7M=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":10256},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","browser":"./dist/index.umd.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"gitHead":"24df167d2fb7671f6b289512650a20a43cb4a8ca","scripts":{"dev":"vite build --watch","lint":"tsc --noEmit && eslint . --cache --cache-location ../../node_modules/.eslint","test":"vitest","build":"vite build && npm run types","start":"vite","types":"tsc -d --emitDeclarationOnly --outDir ./dist","format":"prettier . --write --cache-location ../../node_modules/.prettier --ignore-path ../../.prettierignore","coverage":"vitest run --coverage"},"_npmUser":{"name":"bent10","email":"bent10@stilearning.com"},"repository":{"url":"git+https://github.com/bent10/marked-extensions.git","type":"git"},"_npmVersion":"10.5.2","description":"A marked extension to convert Markdown to Plaintext","directories":{},"_nodeVersion":"20.9.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"peerDependencies":{"marked":">=7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/marked-plaintify_1.0.0_1713762922342_0.40587496816237945","host":"s3://npm-registry-packages"}},"1.0.1":{"name":"marked-plaintify","version":"1.0.1","keywords":["marked","marked-extension","markdown","plaintext","text","document","strip","nlp","stilearning-marked-extensions"],"author":{"url":"https://stilearning.com","name":"Beni Arisandi"},"license":"MIT","_id":"marked-plaintify@1.0.1","maintainers":[{"name":"bent10","email":"bent10@stilearning.com"}],"homepage":"https://github.com/bent10/marked-extensions/tree/main/packages/plaintify","bugs":{"url":"https://github.com/bent10/marked-extensions/issues"},"dist":{"shasum":"823a85ca2f9f9483c7e27743f5691d4f12db1e4a","tarball":"https://registry.npmjs.org/marked-plaintify/-/marked-plaintify-1.0.1.tgz","fileCount":7,"integrity":"sha512-KQhxtuVWf3Ij3YMiW4ArlgNOVmzOAlP0o/upsu2+h7Q4TCAwG4UvkYTteZF2sDDomXQnNSLmfyAhoR0gx2Orgw==","signatures":[{"sig":"MEUCIQCOXPw98oEMNXWuxv29FKBWlGfvWQC4OzbLQwlcLI7nugIgFphbhES//VWeT43eloz3JfBTHUOwOHJQAhe9yqUviWA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":11176},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","browser":"./dist/index.umd.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"gitHead":"71e90be0251433b3a71f7c2d9f3b3f079eff16ea","scripts":{"dev":"vite build --watch","lint":"tsc --noEmit && eslint . --cache --cache-location ../../node_modules/.eslint","test":"vitest","build":"vite build && npm run types","start":"vite","types":"tsc -d --emitDeclarationOnly --outDir ./dist","format":"prettier . --write --cache-location ../../node_modules/.prettier --ignore-path ../../.prettierignore","coverage":"vitest run --coverage"},"_npmUser":{"name":"bent10","email":"bent10@stilearning.com"},"repository":{"url":"git+https://github.com/bent10/marked-extensions.git","type":"git"},"_npmVersion":"10.5.2","description":"A marked extension to convert Markdown to Plaintext","directories":{},"_nodeVersion":"20.9.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"peerDependencies":{"marked":">=7.0.0"},"_npmOperationalInternal":{"tmp":"tmp/marked-plaintify_1.0.1_1713875670815_0.5444415202123489","host":"s3://npm-registry-packages"}},"1.1.0":{"name":"marked-plaintify","version":"1.1.0","keywords":["marked","marked-extension","markdown","plaintext","text","document","strip","nlp","stilearning-marked-extensions"],"author":{"url":"https://stilearning.com","name":"Beni Arisandi"},"license":"MIT","_id":"marked-plaintify@1.1.0","maintainers":[{"name":"bent10","email":"bent10@stilearning.com"}],"homepage":"https://github.com/bent10/marked-extensions/tree/main/packages/plaintify","bugs":{"url":"https://github.com/bent10/marked-extensions/issues"},"dist":{"shasum":"0d6561f5819dff8e35702730a4102fead08806fc","tarball":"https://registry.npmjs.org/marked-plaintify/-/marked-plaintify-1.1.0.tgz","fileCount":7,"integrity":"sha512-Eu2HxMCrso8Z8GManAg0lxCjk7iY5hqq0h5P15KZnmVu7m+spMPQBWfXBU8mLW1xBX3ubCASQ82WaPHq0f+g3w==","signatures":[{"sig":"MEUCIFojFHaXhr1LoNYx26brcgf+2LO54I2LrSjs3G66J8GjAiEAxO06W8bYSZJokakDpS560IKVheHURGp/z31j+JnMv+0=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":14658},"main":"./dist/index.cjs","type":"module","types":"./dist/index.d.ts","module":"./dist/index.js","browser":"./dist/index.umd.js","exports":{".":{"types":"./dist/index.d.ts","import":"./dist/index.js","require":"./dist/index.cjs"}},"gitHead":"897b575d5650f6ec1d77e971ab7260be0d9e8eb7","scripts":{"dev":"vite build --watch","lint":"tsc --noEmit && eslint . --cache --cache-location ../../node_modules/.eslint","test":"vitest","build":"vite build && npm run types","start":"vite","types":"tsc -d --emitDeclarationOnly --outDir ./dist","format":"prettier . --write --cache-location ../../node_modules/.prettier --ignore-path ../../.prettierignore","coverage":"vitest run --coverage"},"_npmUser":{"name":"bent10","email":"bent10@stilearning.com"},"repository":{"url":"git+https://github.com/bent10/marked-extensions.git","type":"git"},"_npmVersion":"10.8.2","description":"A marked extension to convert Markdown to Plaintext","directories":{},"_nodeVersion":"20.9.0","publishConfig":{"access":"public"},"_hasShrinkwrap":false,"peerDependencies":{"marked":">=13.0.0"},"_npmOperationalInternal":{"tmp":"tmp/marked-plaintify_1.1.0_1722360411299_0.11206611208181805","host":"s3://npm-registry-packages"}},"1.1.1":{"name":"marked-plaintify","description":"A marked extension to convert Markdown to Plaintext","version":"1.1.1","publishConfig":{"access":"public"},"author":{"name":"Beni Arisandi","url":"https://stilearning.com"},"repository":{"type":"git","url":"git+https://github.com/bent10/marked-extensions.git"},"homepage":"https://github.com/bent10/marked-extensions/tree/main/packages/plaintify","license":"MIT","keywords":["marked","marked-extension","markdown","plaintext","text","document","strip","nlp","stilearning-marked-extensions"],"type":"module","main":"./dist/index.cjs","browser":"./dist/index.umd.js","module":"./dist/index.js","types":"./dist/index.d.ts","exports":{".":{"import":"./dist/index.js","require":"./dist/index.cjs","types":"./dist/index.d.ts"}},"scripts":{"start":"vite","dev":"vite build --watch","build":"vite build && npm run types","test":"vitest","coverage":"vitest run --coverage","types":"tsc -d --emitDeclarationOnly --outDir ./dist","lint":"tsc --noEmit && eslint . --cache --cache-location ../../node_modules/.eslint","format":"prettier . --write --cache-location ../../node_modules/.prettier --ignore-path ../../.prettierignore"},"peerDependencies":{"marked":">=13.0.0"},"_id":"marked-plaintify@1.1.1","gitHead":"2d9ad3d59ea0d06d44f0b5fa13e06fcb8cd984d4","bugs":{"url":"https://github.com/bent10/marked-extensions/issues"},"_nodeVersion":"20.17.0","_npmVersion":"10.8.3","dist":{"integrity":"sha512-r3kMKArhfo2H3lD4ctFq/OJTzM0uNvXHh7FBTI1hMDpf4Ac1djjtq4g8NfTBWMxWLmaEz3KL1jCkLygik3gExA==","shasum":"5e0da2169d1ad251aaface252b9d9c9f91fc64f0","tarball":"https://registry.npmjs.org/marked-plaintify/-/marked-plaintify-1.1.1.tgz","fileCount":7,"unpackedSize":14875,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBj6nTOqIn/fIj9py8nCNUfge3kPzxRYRe45hR71w+PFAiBeu6hSDY/tuXFhWK7EYgQC9VLq5jTyQXHlJcKhuoB02g=="}]},"_npmUser":{"name":"bent10","email":"bent10@stilearning.com"},"directories":{},"maintainers":[{"name":"bent10","email":"bent10@stilearning.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/marked-plaintify_1.1.1_1724897343414_0.2986945037774116"},"_hasShrinkwrap":false}},"time":{"created":"2024-04-22T05:15:22.192Z","modified":"2024-08-29T02:09:03.822Z","1.0.0":"2024-04-22T05:15:22.585Z","1.0.1":"2024-04-23T12:34:30.953Z","1.1.0":"2024-07-30T17:26:51.511Z","1.1.1":"2024-08-29T02:09:03.653Z"},"bugs":{"url":"https://github.com/bent10/marked-extensions/issues"},"author":{"name":"Beni Arisandi","url":"https://stilearning.com"},"license":"MIT","homepage":"https://github.com/bent10/marked-extensions/tree/main/packages/plaintify","keywords":["marked","marked-extension","markdown","plaintext","text","document","strip","nlp","stilearning-marked-extensions"],"repository":{"type":"git","url":"git+https://github.com/bent10/marked-extensions.git"},"description":"A marked extension to convert Markdown to Plaintext","maintainers":[{"name":"bent10","email":"bent10@stilearning.com"}],"readme":"# marked-plaintify\n\nA [marked](https://marked.js.org/) extension to convert Markdown to Plaintext.\n\n- [Install](#install)\n- [Usage](#usage)\n- [API](#api)\n  - [`markedPlaintify(options: Options): MarkedExtension`](#markedplaintifyoptions-options-markedextension)\n- [Related](#related)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Install\n\nYou can install `marked-plaintify` using npm or yarn:\n\n```bash\nnpm i marked-plaintify\n# or\nyarn add marked-plaintify\n```\n\n## Usage\n\nOnce you've installed this extension, you can use it in your marked configuration. Here's an example of how to configure it:\n\nSay we have the following file `example.md`:\n\n<details>\n<summary>Click to view `example.md`:</summary>\n\n````md\n# GitHub Flavored Markdown (GFM) Specifications Demo\n\nThis document showcases various features and specifications of GitHub Flavored Markdown (GFM).\n\n## 1. Headings\n\n### This is a third-level heading\n\n#### This is a fourth-level heading\n\n## 2. Emphasis\n\n_This text will be italic_\n_This will also be italic_\n\n**This text will be bold**\n**This will also be bold**\n\n## 3. Lists\n\n### Unordered List\n\n- Item 1\n- Item 2\n  - Item 2a\n  - Item 2b\n\n### Ordered List\n\n1. First item\n2. Second item\n3. Third item\n   1. Indented item\n   2. Indented item\n\n## 4. Links\n\n[Github](https://github.com) - Renders as a link to GitHub.\n\n## 5. Images\n\n![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)\n\n## 6. Blockquotes\n\n> This is a blockquote\n\n## 7. Inline code\n\nThis is an `inline code` example.\n\n## 8. Code blocks\n\n```javascript\nfunction greet(name) {\n  console.log('Hello, ' + name + '!')\n}\n\ngreet('World')\n```\n\n## 9. Strikethrough\n\n~~This text is strikethrough.~~\n\n## 10. Tables\n\n| Column 1 | Column 2 | Column 3 |\n| -------- | -------- | -------- |\n| Cell 1   | Cell 2   | Cell 3   |\n| Cell 4   | Cell 5   | Cell 6   |\n\n## 11. Task lists\n\n- [x] Task 1\n- [x] Task 2\n- [ ] Task 3\n\n## 12. Mentioning users and issues\n\n@username, #123\n\n## 13. Emoji\n\n:smile:, :rocket:, :octocat:\n\n## 14. Automatic linking for URLs\n\nhttps://www.google.com\n\n## 15. Strikethrough\n\n~~Strikethrough~~\n\n## 16. Ignoring Markdown formatting\n\n\\*This will not be italic\\*\n\n## 17. Tables\n\n| Markdown | Less      | Pretty     |\n| -------- | --------- | ---------- |\n| _Still_  | `renders` | **nicely** |\n| 1        | 2         | 3          |\n\n## 18. Fenced code blocks with language syntax highlighting\n\n```python\ndef hello():\n    print(\"Hello, World!\")\n```\n\n## 19. Disabling line breaks in paragraphs\n\nThis is a paragraph that demonstrates how to\ndisable line breaks.\n\n## 20. Automatic linking for URLs\n\nwww.example.com\n````\n\n</details>\n\nAnd our module `example.js` looks as follows:\n\n```js\nimport { readFileSync } from 'node:fs'\nimport { Marked } from 'marked'\nimport markedPlaintify from 'marked-plaintify'\n\nconst plaintext = new Marked({ gfm: true })\n  .use(markedPlaintify())\n  .parse(readFileSync('example.md', 'utf8'))\n\nconsole.log(plaintext)\n```\n\nNow, running node `example.js` yields:\n\n```text\nGitHub Flavored Markdown (GFM) Specifications Demo\n\nThis document showcases various features and specifications of GitHub Flavored Markdown (GFM).\n\n1. Headings\n\nThis is a third-level heading\n\nThis is a fourth-level heading\n\n2. Emphasis\n\nThis text will be italic\nThis will also be italic\n\nThis text will be bold\nThis will also be bold\n\n3. Lists\n\nUnordered List\n\n\nItem 1\nItem 2\nItem 2a\nItem 2b\n\nOrdered List\n\n\nFirst item\nSecond item\nThird item\nIndented item\nIndented item\n\n4. Links\n\nGithub - Renders as a link to GitHub.\n\n5. Images\n\nGitHub Logo\n\n6. Blockquotes\n\nThis is a blockquote\n\n7. Inline code\n\nThis is an inline code example.\n\n8. Code blocks\n\nfunction greet(name) {\n  console.log('Hello, ' + name + '!')\n}\n\ngreet('World')\n\n9. Strikethrough\n\nThis text is strikethrough.\n\n10. Tables\n\nColumn 1: Cell 1\nColumn 2: Cell 2\nColumn 3: Cell 3\n\nColumn 1: Cell 4\nColumn 2: Cell 5\nColumn 3: Cell 6\n\n11. Task lists\n\n\nTask 1\nTask 2\nTask 3\n\n12. Mentioning users and issues\n\n@username, #123\n\n13. Emoji\n\n:smile:, :rocket:, :octocat:\n\n14. Automatic linking for URLs\n\nhttps://www.google.com\n\n15. Strikethrough\n\nStrikethrough\n\n16. Ignoring Markdown formatting\n\nThis will not be italic\n\n17. Tables\n\nMarkdown: Still\nLess: renders\nPretty: nicely\n\nMarkdown: 1\nLess: 2\nPretty: 3\n\n18. Fenced code blocks with language syntax highlighting\n\ndef hello():\n    print(\"Hello, World!\")\n\n19. Disabling line breaks in paragraphs\n\nThis is a paragraph that demonstrates how to\ndisable line breaks.\n\n20. Automatic linking for URLs\n\nwww.example.com\n```\n\n## API\n\n### `markedPlaintify(options: Options): MarkedExtension`\n\nThis function creates a `marked` extension to convert Markdown to plaintext.\n\n- `options`: Custom renderers for configuring the `marked-plaintify` extension. It's an object where keys represent renderer names and values are functions that take arguments and return plaintext strings or `false`.\n\n## Related\n\nSee [extensions list](https://github.com/bent10/marked-extensions#packages).\n\n## Contributing\n\nWe 💛&nbsp; issues.\n\nWhen committing, please conform to [the semantic-release commit standards](https://www.conventionalcommits.org/). Please install `commitizen` and the adapter globally, if you have not already.\n\n```bash\nnpm i -g commitizen cz-conventional-changelog\n```\n\nNow you can use `git cz` or just `cz` instead of `git commit` when committing. You can also use `git-cz`, which is an alias for `cz`.\n\n```bash\ngit add . && git cz\n```\n\n## License\n\n![GitHub](https://img.shields.io/github/license/bent10/marked-extensions)\n\nA project by [Stilearning](https://stilearning.com) &copy; 2023-2024.\n","readmeFilename":"readme.md"}