{"_id":"@elricb/ink-project-markdown","_rev":"2-1bbe0b12eca632978b27c704d504f732","name":"@elricb/ink-project-markdown","dist-tags":{"latest":"0.0.2"},"versions":{"0.0.1":{"name":"@elricb/ink-project-markdown","version":"0.0.1","description":"View base project markdown files for Ink","license":"MIT","repository":{"type":"git","url":"git+https://github.com/elricb/ink-project-markdown.git"},"author":{"name":"elricb","url":"github.com/elricb"},"main":"lib","engines":{"node":">=11"},"scripts":{"build":"babel src/ -d lib/","release":"npm run build && npm run lint && npm test && npm publish","example":"node lib/example/index.js","lint":"xo","test":"ava","test-update-snapshots":"ava --update-snapshots"},"keywords":["ink","component","jsx","react","markdown"],"devDependencies":{"@ava/babel":"^2.0","@babel/cli":"^7.15.4","@babel/core":"^7.15.5","@babel/plugin-transform-react-jsx":"^7.14.9","@babel/preset-env":"^7.15.6","@babel/preset-react":"^7.14.5","@elricb/prettier-config":"0.0.1","@elricb/xo-config":"0.0.2","ava":"^3.15.0","eslint-config-xo-react":"^0.25.0","eslint-plugin-react":"^7.20.0","eslint-plugin-react-hooks":"^4.0.4","ink":"^3.0.5","ink-markdown":"^1.0.1","ink-testing-library":"^2.0.0","prettier":"^2.4.1","pretty-quick":"^3.1.1","react":"^17.0.2","xo":"^0.44.0"},"peerDependencies":{"ink":"^3.0.5","react":"^17.0.2"},"prettier":"@elricb/prettier-config","ava":{"babel":{"testOptions":{"presets":["@babel/preset-react"]}}},"babel":{"presets":[],"plugins":["@babel/plugin-transform-react-jsx"]},"dependencies":{},"bugs":{"url":"https://github.com/elricb/ink-project-markdown/issues"},"homepage":"https://github.com/elricb/ink-project-markdown#readme","directories":{"doc":"docs","lib":"lib","test":"test"},"gitHead":"4a4bbeea56e0c5a99df5fc9e7b2d5a6803a5acb4","_id":"@elricb/ink-project-markdown@0.0.1","_nodeVersion":"14.17.6","_npmVersion":"6.14.15","dist":{"integrity":"sha512-18QNHyJ4j0rdnvs74Cpdo6e43VFADDAEDt5yqTb4ksUjAmtV5zvEg74xpyER9J00MF6n7vIvazWwtgYznf2ceQ==","shasum":"4e06f1dcac5e2c4b330bf8783fb16024eb035d5f","tarball":"https://registry.npmjs.org/@elricb/ink-project-markdown/-/ink-project-markdown-0.0.1.tgz","fileCount":13,"unpackedSize":14087,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIH5D+XDtEcPRPXkz956+GkhzoT7725NwTemkttaDk1RwAiBqgcXLwr/AWE1KrCBCHiOQa6nddnZhKGV+VBb6JdcNKQ=="}]},"_npmUser":{"name":"elricb","email":"elricb@elricbest.com"},"maintainers":[{"name":"elricb","email":"elricb@elricbest.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ink-project-markdown_0.0.1_1634838667699_0.8268581296154704"},"_hasShrinkwrap":false},"0.0.2":{"name":"@elricb/ink-project-markdown","version":"0.0.2","description":"View base project markdown files for Ink","license":"MIT","repository":{"type":"git","url":"git+https://github.com/elricb/ink-project-markdown.git"},"author":{"name":"elricb","url":"github.com/elricb"},"main":"lib","engines":{"node":">=11"},"scripts":{"build":"babel src/ -d lib/","release":"npm run build && npm run lint && npm test && npm publish","example":"node lib/example/index.js","lint":"xo","test":"ava","test-update-snapshots":"ava --update-snapshots"},"keywords":["ink","component","jsx","react","markdown"],"devDependencies":{"@ava/babel":"^2.0","@babel/cli":"^7.15.4","@babel/core":"^7.15.5","@babel/plugin-transform-react-jsx":"^7.14.9","@babel/preset-env":"^7.15.6","@babel/preset-react":"^7.14.5","@elricb/prettier-config":"0.0.1","@elricb/xo-config":"0.0.2","ava":"^3.15.0","eslint-config-xo-react":"^0.25.0","eslint-plugin-react":"^7.20.0","eslint-plugin-react-hooks":"^4.0.4","ink":"^3.0.5","ink-testing-library":"^2.0.0","prettier":"^2.4.1","pretty-quick":"^3.1.1","react":"^17.0.2","xo":"^0.44.0"},"peerDependencies":{"ink":"^3.0.5","react":"^17.0.2"},"prettier":"@elricb/prettier-config","ava":{"babel":{"testOptions":{"presets":["@babel/preset-react"]}}},"babel":{"presets":[],"plugins":["@babel/plugin-transform-react-jsx"]},"dependencies":{"ink-markdown":"^1.0.1"},"bugs":{"url":"https://github.com/elricb/ink-project-markdown/issues"},"homepage":"https://github.com/elricb/ink-project-markdown#readme","directories":{"doc":"docs","lib":"lib","test":"test"},"gitHead":"380bdc8925d3a67c36909265461c6eda13be3000","_id":"@elricb/ink-project-markdown@0.0.2","_nodeVersion":"14.18.1","_npmVersion":"6.14.15","dist":{"integrity":"sha512-xTcc6icZIcYh9ZHnDn6HBh8BAYrqxeIdjzxvyfGwKSWIPbg8FlLXQiV0JYYh3zjKh6IwlHMA4N9nVBA3/xI5jw==","shasum":"4c5fd63fdbc04cd585cf0f662b5758ba6aefa2fa","tarball":"https://registry.npmjs.org/@elricb/ink-project-markdown/-/ink-project-markdown-0.0.2.tgz","fileCount":13,"unpackedSize":14089,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJhpWy/CRA9TVsSAnZWagAATqMP/1J5b51vh18cwDB31h4B\nsfCD7jl+XuGcR0NxV0/DaMil7xOKH6KCtkpSBwU3Hq2H5DNxZ4pHwp+ihtfS\n0SmvGiQm4ktYa3Z1YZeNMO7vtaAPMQvTZsTb9RjU2+YkSKhvsCVxY+1JXe+5\nnzN4zkWl9zEBGk+yZ9szR3/N791fUxbq3PuhbQpuSdWekMKTMHD3YeV3q6q0\nZZealJp8+wZrttaDQ/GzGtPeRw/6o5o6RIL3arGAkOQ7/hcjm71HZOCxyuQa\n6v3ktFc1Qlnzf6wF0u4H5i3aO0RfqLp04YheReaajLlzOVLNCcTSebheXWBq\n+rBhq+CU4GC1WtfM/II04x5/9GP/SKSgT/kwlcdlTz/JmwOr4WHre/Q2gZef\nTwWjZohUpF2+CMKzEF5nj6Kv/hKT2uKWw+yPJk9zPaQyJf8xj4C68MAUcnWs\nmghSX8KB8WvJQQZ8kIXgYppxs/yTUJLPRJC4n9ljW9nccHaEjrFAiVid1wpA\njpQdXCEajxvF+w1pWsXWT3pSlKZ+fnaDOerEO7KuiqUi9nI/LknquRq5c7hF\nMGrBQ1bwmYxSEhFtNPwuEVJ/6SLvpgNjvzHLRr3UG09sRJ8Kw3BiY7kYfw+O\nNjhlZ2E/6jZUpXn+JmhEwSQq0bw2shNPfIKthd7pQCY+gNMaiLxOkJHSjcWL\nMWza\r\n=5EPA\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFqkPeUQv0a8KIRYGOEvnEkL9GLpdM+3tPuMCd9IPTKLAiAEOWXdtQW2y6a7rFTqjHYtCWARrqbaAEBL6opLAW3iOA=="}]},"_npmUser":{"name":"elricb","email":"elricb@elricbest.com"},"maintainers":[{"name":"elricb","email":"elricb@elricbest.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/ink-project-markdown_0.0.2_1638231231131_0.5579091332344495"},"_hasShrinkwrap":false}},"time":{"created":"2021-10-21T17:51:07.647Z","0.0.1":"2021-10-21T17:51:07.829Z","modified":"2022-04-05T07:23:04.828Z","0.0.2":"2021-11-30T00:13:51.253Z"},"maintainers":[{"name":"elricb","email":"elricb@elricbest.com"}],"description":"View base project markdown files for Ink","homepage":"https://github.com/elricb/ink-project-markdown#readme","keywords":["ink","component","jsx","react","markdown"],"repository":{"type":"git","url":"git+https://github.com/elricb/ink-project-markdown.git"},"author":{"name":"elricb","url":"github.com/elricb"},"bugs":{"url":"https://github.com/elricb/ink-project-markdown/issues"},"license":"MIT","readme":"# @elricb/ink-project-markdown\n\n> Box list component for [Ink](https://github.com/vadimdemedes/ink).\n\nView markdown files related to base project.\n\n## Install\n\n```\n$ npm install @elricb/ink-project-markdown\n```\n\n## Usage\n\n[Ink](https://github.com/vadimdemedes/ink) example\n\n```jsx\nimport React from \"react\";\nimport {render, Text} from \"ink\";\nimport ProjectMarkdown from \"@elricb/ink-project-markdown\";\n\nconst Readme = () => (\n  <ProjectMarkdown baseDir=\"project/path\" suspense={<Text>Loading</Text>} />\n);\n\nrender(<Readme />);\n```\n\n[Pastel](https://www.npmjs.com/package/pastel) example\n\n```jsx\nimport React from \"react\";\nimport PropTypes from \"prop-types\";\nimport ProjectMarkdown from \"@elricb/ink-project-markdown\";\n\n/// displays readme.md in terminal from project root \nconst Readme = ({module}) => (\n  module\n    ? <ProjectMarkdown baseDir=\"project/path\" filename={module} />\n    : <ProjectMarkdown baseDir=\"project/path\" />\n);\n\nReadme.propTypes = {\n  /// select file from docs/ to open\n  module: PropTypes.string,\n};\n\nReadme.shortFlags = {\n  module: \"m\",\n};\n\nexport default Readme;\n```\n\n## Props\n\n### baseDir\n\nType: `string`\nRequired\n\nThe project directory.\n\n### filename\n\nType: `string`\nDefault: `readme.md` or `README.md`\n\nFilename to view.  `.md` extension is optional.\n\n### docsDir\n\nType: `string`\nDefault: `docs`\n\nDirectory in project root to serach for markdown files.  Defaults to `docs` directory.\n\n### suspense\n\nType: `string` / `element` / `null`\nDefault: `null`\n\nDisplay while markdown file is loading.\n\n\n","readmeFilename":"readme.md"}