{"_id":"@blockquote/cem-to-markdown-readme","name":"@blockquote/cem-to-markdown-readme","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@blockquote/cem-to-markdown-readme","version":"1.0.0","description":"Custom Element Manifest Plugin: Creates a README from a custom-elements.json","keywords":["custom-elements","custom-elements-json","custom-elements-manifest","customelements","README"],"license":"MIT","type":"module","exports":{".":{"default":"./index.js"},"./index.js":{"default":"./index.js"},"./package.json":{"default":"./package.json"}},"main":"index.js","module":"index.js","dependencies":{"@blockquote/to-markdown":"^0.1.0","@custom-elements-manifest/analyzer":"^0.8.4"},"publishConfig":{"access":"public"},"gitHead":"0a1033c147e0f1dd58c907cb1f0286cf8d97e047","_id":"@blockquote/cem-to-markdown-readme@1.0.0","_nodeVersion":"18.17.1","_npmVersion":"9.6.7","dist":{"integrity":"sha512-H4wnhtrGDOrNwZlFPmmI/+VBPagyx2MkNSjPZP3ftGNecM6AD81N/4mIqr4J1oZucvUoEZI3f8fRB+XupmOGRg==","shasum":"6280aca19dcdb193f4e246af28c004377d809cbe","tarball":"https://registry.npmjs.org/@blockquote/cem-to-markdown-readme/-/cem-to-markdown-readme-1.0.0.tgz","fileCount":6,"unpackedSize":6769,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBd6z1a7zUjh1Cr9jWZybJlGVmL3z7o1A/1JZLL7qY0HAiBb4FeksXYB5sH39QdGim69mx/FGL/6bJlTWqfpPO2liQ=="}]},"_npmUser":{"name":"oscarmarina","email":"oscar7600@outlook.com"},"directories":{},"maintainers":[{"name":"oscarmarina","email":"oscar7600@outlook.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/cem-to-markdown-readme_1.0.0_1694789713599_0.9339033712671587"},"_hasShrinkwrap":false}},"time":{"created":"2023-09-15T14:55:13.499Z","1.0.0":"2023-09-15T14:55:13.808Z","modified":"2023-09-15T14:55:14.110Z"},"maintainers":[{"name":"oscarmarina","email":"oscar7600@outlook.com"}],"description":"Custom Element Manifest Plugin: Creates a README from a custom-elements.json","keywords":["custom-elements","custom-elements-json","custom-elements-manifest","customelements","README"],"license":"MIT","readme":"## Custom Element Manifest Plugin:\n\n### Generating README from custom-elements.json\n\n`cem-to-markdown-readme` combines the functionality of two community plugins:\n\n- A variant of the [to-markdown plugin](https://github.com/open-wc/custom-elements-manifest/tree/master/packages/to-markdown), with added support for the 'description' section in classes and mixins.\n\n- The [cem-plugin-readonly plugin](https://github.com/bennypowers/cem-plugins/tree/main/plugins/cem-plugin-readonly).\n\nAll configuration options are as described in this [document - README-to-markdown](https://github.com/oscarmarina/to-markdown/blob/main/README.md), and it also utilizes an additional option, 'filename,' which corresponds to the 'file' option in the [fs.writeFileSync(file, data[, options])](https://nodejs.org/api/fs.html#fswritefilesyncfile-data-options) method.\n\n## Usage\n\n### Installation:\n\n```bash\nnpm install --save-dev @blockquote/cem-to-markdown-readme\n```\n\n### Import\n\nAdd the following code to your [_custom-elements-manifest.config.js_](https://custom-elements-manifest.open-wc.org/analyzer/config/#config-file):\n\n```js\nimport { cemToMarkdownReadme } from '@blockquote/cem-to-markdown-readme';\n\nexport default {\n  plugins: [...cemToMarkdownReadme()],\n};\n```\n\n<hr>\n\nConfiguration options required to use the original `to-markdown` plugin by default.\n\n```js\n// @override: {private:'details', headingOffset = 2, omitSections = ['super-class']}\n\nexport default {\n  plugins: [\n    ...cemToMarkdownReadme({\n      private: 'all',\n      headingOffset: 0,\n      omitSections: [],\n    }),\n  ],\n};\n```\n\n<hr>\n\nConfiguration filename option.\n\n```js\nexport default {\n  plugins: [\n    ...cemToMarkdownReadme({\n      filename: 'internal-readme.md',\n    }),\n  ],\n};\n```\n","readmeFilename":"README.md"}