{"_id":"read-md-safe","_rev":"2425526","name":"read-md-safe","description":"Read markdown files as a Marked token list or string","dist-tags":{"latest":"1.0.5"},"maintainers":[{"name":"bconnorwhite","email":"connor.bcw@gmail.com"}],"time":{"modified":"2022-01-17T00:51:19.000Z","created":"2020-09-07T03:32:24.306Z","1.0.5":"2022-01-17T00:47:08.400Z","1.0.4":"2021-03-30T20:33:11.895Z","1.0.3":"2020-10-11T16:11:32.064Z","1.0.2":"2020-09-30T22:47:07.333Z","1.0.1":"2020-09-07T03:37:07.732Z","1.0.0":"2020-09-07T03:32:24.306Z"},"users":{},"author":{"name":"Connor White","email":"connor.bcw@gmail.com","url":"https://connorwhite.org"},"repository":{"type":"git","url":"git+https://github.com/bconnorwhite/read-md-safe.git"},"versions":{"1.0.5":{"name":"read-md-safe","version":"1.0.5","description":"Read markdown files as a Marked token list or string","license":"MIT","author":{"name":"Connor White","email":"connor.bcw@gmail.com","url":"https://connorwhite.org"},"homepage":"https://connorwhite.org/github/read-md-safe","repository":{"type":"git","url":"git+https://github.com/bconnorwhite/read-md-safe.git"},"keywords":["read","markdown","md","parse","safe","without","try","catch","json"],"main":"./build/index.js","scripts":{"build":"bob build","commit":"bob commit","lint":"bob lint","postversion":"git push","prepublishOnly":"yarn run build","release":"bob publish","test":"bob test"},"dependencies":{"marked":"^4.0.10","read-file-safe":"^1.0.10"},"devDependencies":{"@bconnorwhite/bob":"^2.9.2","@types/marked":"^4.0.1","@types/mock-fs":"^4.13.0","mock-fs":"^4.13.0"},"eslintConfig":{"extends":"eslint-config-bob"},"husky":{"hooks":{"commit-msg":"bob lint commit"}},"npmpackagejsonlint":{"extends":"npm-package-json-lint-config-bob"},"_id":"read-md-safe@1.0.5","dist":{"shasum":"b8b3b824dbd51fb73b86c0d0b77001064647bb13","size":2584,"noattachment":false,"key":"/read-md-safe/-/read-md-safe-1.0.5.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-md-safe/download/read-md-safe-1.0.5.tgz"},"_npmUser":{"name":"bconnorwhite","email":"connor.bcw@gmail.com"},"directories":{},"maintainers":[{"name":"bconnorwhite","email":"connor.bcw@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/read-md-safe_1.0.5_1642380428207_0.20871412676158152"},"_hasShrinkwrap":false,"_cnpmcore_publish_time":"2022-01-17T00:47:14.287Z","publish_time":1642380428400,"_cnpm_publish_time":1642380428400},"1.0.4":{"name":"read-md-safe","version":"1.0.4","description":"Read markdown files as a Marked token list or string","license":"MIT","author":{"name":"Connor White","email":"connor.bcw@gmail.com","url":"https://connorwhite.org"},"homepage":"https://connorwhite.org/github/read-md-safe","repository":{"type":"git","url":"git+https://github.com/bconnorwhite/read-md-safe.git"},"keywords":["read","markdown","md","parse","safe","without","try","catch","json"],"main":"./build/index.js","scripts":{"build":"bob build","commit":"bob commit","lint":"bob lint","postversion":"git push","prepublishOnly":"yarn run build","release":"bob publish","test":"bob test"},"dependencies":{"marked":"^2.0.1","read-file-safe":"^1.0.10"},"devDependencies":{"@bconnorwhite/bob":"^2.9.2","@types/marked":"^2.0.1","@types/mock-fs":"^4.13.0","mock-fs":"^4.13.0"},"eslintConfig":{"extends":"eslint-config-bob"},"husky":{"hooks":{"commit-msg":"bob lint commit"}},"npmpackagejsonlint":{"extends":"npm-package-json-lint-config-bob"},"_id":"read-md-safe@1.0.4","dist":{"shasum":"1be0c9d6682e4923e7e600364cb700da9d9d9c7f","size":2530,"noattachment":false,"key":"/read-md-safe/-/read-md-safe-1.0.4.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-md-safe/download/read-md-safe-1.0.4.tgz"},"_npmUser":{"name":"bconnorwhite","email":"connor.bcw@gmail.com"},"directories":{},"maintainers":[{"name":"bconnorwhite","email":"connor.bcw@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/read-md-safe_1.0.4_1617136391700_0.4316376260923869"},"_hasShrinkwrap":false,"publish_time":1617136391895,"_cnpm_publish_time":1617136391895},"1.0.3":{"name":"read-md-safe","version":"1.0.3","description":"Read markdown files as a Marked token list or string","license":"MIT","author":{"name":"Connor White","email":"connor.bcw@gmail.com","url":"https://connorwhite.org"},"homepage":"https://connorwhite.org/github/read-md-safe","repository":{"type":"git","url":"git+https://github.com/bconnorwhite/read-md-safe.git"},"keywords":["read","markdown","md","parse","safe","without","try","catch","json"],"main":"./build/index.js","scripts":{"build":"bob build","commit":"bob commit","lint":"bob lint","postversion":"git push","prepublishOnly":"yarn run build","release":"bob publish","test":"bob test"},"dependencies":{"@types/marked":"^1.1.0","marked":"^1.1.1","read-file-safe":"^1.0.10"},"devDependencies":{"@bconnorwhite/bob":"^2.9.2","@types/mock-fs":"^4.13.0","mock-fs":"^4.13.0"},"eslintConfig":{"extends":"eslint-config-bob"},"husky":{"hooks":{"commit-msg":"bob lint commit"}},"npmpackagejsonlint":{"extends":"npm-package-json-lint-config-bob"},"_id":"read-md-safe@1.0.3","dist":{"shasum":"7d01a0688f9cda7ed484e768b86952945365df14","size":2456,"noattachment":false,"key":"/read-md-safe/-/read-md-safe-1.0.3.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-md-safe/download/read-md-safe-1.0.3.tgz"},"maintainers":[{"name":"bconnorwhite","email":"connor.bcw@gmail.com"}],"_npmUser":{"name":"bconnorwhite","email":"connor.bcw@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/read-md-safe_1.0.3_1602432691926_0.7709672975923725"},"_hasShrinkwrap":false,"publish_time":1602432692064,"_cnpm_publish_time":1602432692064},"1.0.2":{"name":"read-md-safe","version":"1.0.2","description":"Read markdown files as a Marked token list or string","license":"MIT","author":{"name":"Connor White","email":"connor.bcw@gmail.com","url":"https://connorwhite.org"},"homepage":"https://connorwhite.org/github/read-md-safe","repository":{"type":"git","url":"git+https://github.com/bconnorwhite/read-md-safe.git"},"keywords":["read","markdown","md","parse","safe","without","try","catch","json"],"main":"./build/index.js","scripts":{"build":"bob build","postversion":"git push","prepublishOnly":"yarn run build"},"dependencies":{"@types/marked":"^1.1.0","marked":"^1.1.1"},"devDependencies":{"@bconnorwhite/bob":"^2.0.1"},"_id":"read-md-safe@1.0.2","dist":{"shasum":"7c4f5e8cbc3e7880b1741fd99e985a928c6a6257","size":1944,"noattachment":false,"key":"/read-md-safe/-/read-md-safe-1.0.2.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-md-safe/download/read-md-safe-1.0.2.tgz"},"maintainers":[{"name":"bconnorwhite","email":"connor.bcw@gmail.com"}],"_npmUser":{"name":"bconnorwhite","email":"connor.bcw@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/read-md-safe_1.0.2_1601506027203_0.8410863851361552"},"_hasShrinkwrap":false,"publish_time":1601506027333,"_cnpm_publish_time":1601506027333},"1.0.1":{"name":"read-md-safe","version":"1.0.1","description":"Read markdown files as a Marked token list or string","license":"MIT","author":{"name":"Connor White","email":"connor.bcw@gmail.com","url":"https://connorwhite.org"},"homepage":"https://connorwhite.org/github/read-md-safe","repository":{"type":"git","url":"git+https://github.com/bconnorwhite/read-md-safe.git"},"keywords":[],"main":"./build/index.js","scripts":{"build":"bob build","postversion":"git push","prepublishOnly":"yarn run build"},"devDependencies":{"@bconnorwhite/bob":"^2.0.1","@types/marked":"^1.1.0"},"dependencies":{"marked":"^1.1.1"},"_id":"read-md-safe@1.0.1","dist":{"shasum":"3b046ec7baad444dcde871390d40bf090d13e1a2","size":1895,"noattachment":false,"key":"/read-md-safe/-/read-md-safe-1.0.1.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-md-safe/download/read-md-safe-1.0.1.tgz"},"maintainers":[{"name":"bconnorwhite","email":"connor.bcw@gmail.com"}],"_npmUser":{"name":"bconnorwhite","email":"connor.bcw@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/read-md-safe_1.0.1_1599449827599_0.18661743382277796"},"_hasShrinkwrap":false,"publish_time":1599449827732,"_cnpm_publish_time":1599449827732},"1.0.0":{"name":"read-md-safe","version":"1.0.0","description":"Read markdown files as a Marked token list or string","license":"MIT","author":{"name":"Connor White","email":"connor.bcw@gmail.com","url":"https://connorwhite.org"},"homepage":"https://connorwhite.org/github/read-md-safe","repository":{"type":"git","url":"git+https://github.com/bconnorwhite/read-md-safe.git"},"keywords":[],"main":"./build/index.js","scripts":{"build":"bob build","postversion":"git push","prepublishOnly":"yarn run build"},"devDependencies":{"@bconnorwhite/bob":"^2.0.1","@types/marked":"^1.1.0"},"dependencies":{"marked":"^1.1.1"},"_id":"read-md-safe@1.0.0","dist":{"shasum":"0fec18c9763a6626b436cc9f4c1f15846c1d2503","size":1878,"noattachment":false,"key":"/read-md-safe/-/read-md-safe-1.0.0.tgz","tarball":"http://registry.cnpm.dingdandao.com/read-md-safe/download/read-md-safe-1.0.0.tgz"},"maintainers":[{"name":"bconnorwhite","email":"connor.bcw@gmail.com"}],"_npmUser":{"name":"bconnorwhite","email":"connor.bcw@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/read-md-safe_1.0.0_1599449544205_0.5543877797561101"},"_hasShrinkwrap":false,"publish_time":1599449544306,"_cnpm_publish_time":1599449544306}},"readme":"
\n

read-md-safe

\n \n \"NPM\"\n \n \n \"TypeScript\"\n \n \n \"Coverage\n \n \n \"GitHub\n \n \n \"Twitter\n \n
\n\n
\n\n> Read markdown files as a [Marked](https://www.npmjs.com/package/marked) token list or string.\n\n## Installation\n\n```sh\nyarn add read-md-safe\n```\n\n```sh\nnpm install read-md-safe\n```\n\n## API\n\n### Types\n```ts\nimport {\n readMarkdown,\n readMarkdownSync,\n readMarkdownString,\n readMarkdownStringSync,\n TokensList,\n Token\n} from \"write-file-safe\";\n\nfunction readMarkdown(path: string): Promise;\n\nfunction readMarkdownSync(path: string): TokensList | undefined;\n\nfunction readMarkdownString(path: string): Promise;\n\nfunction readMarkdownStringSync(path: string): string | undefined;\n\n// a Marked token list\ntype TokensList = Token[] & {\n links: {\n [key: string]: {\n href: string | null;\n title: string | null;\n };\n };\n}\n```\n\n
\n\n

Dependencies\"dependencies\"

\n\n- [@types/marked](https://www.npmjs.com/package/@types/marked): TypeScript definitions for Marked\n- [marked](https://www.npmjs.com/package/marked): A markdown parser built for speed\n- [read-file-safe](https://www.npmjs.com/package/read-file-safe): Read files without try catch.\n\n
\n\n

Dev Dependencies\"David\"

\n\n- [@bconnorwhite/bob](https://www.npmjs.com/package/@bconnorwhite/bob): Bob is a toolkit for TypeScript projects\n- [@types/mock-fs](https://www.npmjs.com/package/@types/mock-fs): TypeScript definitions for mock-fs\n- [mock-fs](https://www.npmjs.com/package/mock-fs): A configurable mock file system. You know, for testing.\n\n
\n\n

License \"license\"

\n\n[MIT](https://opensource.org/licenses/MIT)\n\n
\n\n## Related Packages:\n\n- [marked](https://www.npmjs.com/package/marked): A markdown parser built for speed\n- [write-md-safe](https://npmjs.com/package/read-md-safe): Write markdown files from a Marked token list or string.\n- [read-file-safe](https://www.npmjs.com/package/read-file-safe): Read files without try catch.\n","_attachments":{},"homepage":"https://connorwhite.org/github/read-md-safe","license":"MIT"}