@blockquote/cem-to-markdown-readme

Custom Element Manifest Plugin:

Generating README from custom-elements.json

cem-to-markdown-readme combines the functionality of two community plugins:

• A variant of the to-markdown plugin, with added support for the 'description' section in classes and mixins.

• The cem-plugin-readonly plugin.

All configuration options are as described in this document - README-to-markdown, and it also utilizes an additional option, 'filename,' which corresponds to the 'file' option in the fs.writeFileSync(file, data[, options]) method.

Usage

Installation:

npm install --save-dev @blockquote/cem-to-markdown-readme

Import

Add the following code to your custom-elements-manifest.config.js:

import { cemToMarkdownReadme } from '@blockquote/cem-to-markdown-readme';

export default {
  plugins: [...cemToMarkdownReadme()],
};

---

Configuration options required to use the original to-markdown plugin by default.

// @override: {private:'details', headingOffset = 2, omitSections = ['super-class']}

export default {
  plugins: [
    ...cemToMarkdownReadme({
      private: 'all',
      headingOffset: 0,
      omitSections: [],
    }),
  ],
};

---

Configuration filename option.

export default {
  plugins: [
    ...cemToMarkdownReadme({
      filename: 'internal-readme.md',
    }),
  ],
};