{"_id":"@conflux-lib/jsdoc-to-md","_rev":"6-c8e810943fa5acbbf459672d59818d4a","time":{"0.0.6":"2021-10-14T10:29:00.580Z","0.0.7":"2021-10-14T10:29:00.580Z","created":"2021-10-18T02:54:57.538Z","1.0.6":"2021-10-18T02:54:57.708Z","modified":"2022-04-05T00:54:15.135Z"},"name":"@conflux-lib/jsdoc-to-md","dist-tags":{"latest":"1.0.6"},"versions":{"1.0.6":{"name":"@conflux-lib/jsdoc-to-md","version":"1.0.6","author":{"email":"conflux-lib@confluxnetwork.org"},"license":"MIT","private":false,"repository":{"type":"git","url":"git+https://github.com/Argeric/jsdoc-to-md.git"},"keywords":["jsdoc","markdown"],"main":"src/index.js","dependencies":{"jsdoc-api":"^6.0.0","jsdoc-parse":"^5.0.0","lodash":"4.17.15"},"scripts":{"public":"yarn publish --access=public"},"gitHead":"b7cad72eaa08bc98bad3c3953d44c42cab4db548","description":"# Install `npm install @conflux-lib/jsdoc-to-md`","bugs":{"url":"https://github.com/Argeric/jsdoc-to-md/issues"},"homepage":"https://github.com/Argeric/jsdoc-to-md#readme","_id":"@conflux-lib/jsdoc-to-md@1.0.6","_nodeVersion":"14.15.1","_npmVersion":"8.0.0","dist":{"integrity":"sha512-K18eKWJOFYopEia2tjp6lGb1wqT/S1tMj6XjlG9hHrGxKDOVENgZdDLgqDFZZUD+8hkXliJcXLFoj8g1cV2tHQ==","shasum":"2ba772704b8e05e1701e80027b2462bbd4fc67e3","tarball":"https://registry.npmjs.org/@conflux-lib/jsdoc-to-md/-/jsdoc-to-md-1.0.6.tgz","fileCount":6,"unpackedSize":11540,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJh2DSeCRA9TVsSAnZWagAAI8wP/39asYmGS4iwhJ4qb0wi\nK6oxHX9FUWzl5k/AvU0R2nfAD5GrNaOrUfGa9Fat8ITwguzap7LHZ3ViKkP8\n+vy42iL9UgeXztzbFQ/PU/XAhCCuTdLgm3cyNJWHMpjfuw94LdlyZYbu7qId\nXw6KVuyQCH17dgrjfwAcDjixItnsgQZ9BZPdKasafWXUgeifl6Z+ntpRlb2J\n78FP/uhxl1W/g9MCLfTiwTOxTCJ367dwKmUErBMkUFc7qQf2NVFBN+eCz1WU\nggQT35Fjmjhp746oNH89I8LD6aSV1kjf5sxnsAm57EJydlLq7oeP9f54+Xuv\nOyAZtIgGlu6bcYVeGBPqGX/8VA2TaGaYcC19UbsuUKcXl0FXifrDvgNlL5up\njCEhoUNDSOMUwROkduLmSCs4nNHjNVqhiSZ2HXS4z0xDuU28uUF3jGmfPUmr\n35mkVKGC8toN91aJUfnJmV0STtCTBAKK4uG2xUM/Pz5HmDTUXWjYlohMts8o\nhPz3ofRGWUsA3E6nsuphFtjkZ8i+Povnfu/NrOxi8Pk1b85PEh6K08V+Uhhx\nA1M7/VZKatKlPmaywg+Ax7w17fN3T/9aFtfSXQYs7D0DBqOROgOQEK5K4Ixn\nZxn7fB4aOjimoZtebpqgmUcBLgmF/ZHIKsuRCqY4Tt0MjWHr9zw9di85GivE\n5E7Z\r\n=E9TQ\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDejQy/KF7saH5Ui9YI5ck/JRYY2fhWMamZRq+L80TqawIhAO29ym3NU5zviVKM3KpMn0uOuNx02YuJ/r40BKLPHV06"}]},"_npmUser":{"name":"zhentingwang","email":"argeric@qq.com"},"directories":{},"maintainers":[{"name":"zhentingwang","email":"argeric@qq.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/jsdoc-to-md_1.0.6_1634525697578_0.43922187716589334"},"_hasShrinkwrap":false}},"maintainers":[{"name":"zhentingwang","email":"argeric@qq.com"}],"description":"# Install `npm install @conflux-lib/jsdoc-to-md`","homepage":"https://github.com/Argeric/jsdoc-to-md#readme","keywords":["jsdoc","markdown"],"repository":{"type":"git","url":"git+https://github.com/Argeric/jsdoc-to-md.git"},"author":{"email":"conflux-lib@confluxnetwork.org"},"bugs":{"url":"https://github.com/Argeric/jsdoc-to-md/issues"},"license":"MIT","readme":"\n# Jsdoc to Markdown\n\n# Install\n`npm install @conflux-lib/jsdoc-to-md`\n\n# Document\n\n## jsdocToMd <a id=\"index.js/jsdocToMd\"></a>\n\nGenerate directory markdown string.\n\n* **Parameters**\n\nName            | Type       | Required | Default  | Description\n----------------|------------|----------|----------|-----------------------------\npath            | `string`   | true     |          | - Filename or directory path\noptions         | `object`   | false    |          |\noptions.content | `boolean`  | false    | true     | Generate content.\noptions.filter  | `function` | false    | ()=>true | Filename filter/\n\n* **Returns**\n\n`string` Markdown string\n\n* **Examples**\n\n```\n> const jsdocToMd = require('@conflux-lib/jsdoc-to-md')\n> const string = jsdocToMd('./src')\n```\n\n# Example\n\n[see](https://github.com/GeekBerry/jsdoc-to-md/blob/master/example)\n","readmeFilename":"README.md"}