@github/cem-plugin-readme

A Custom Element Manifest Analyzer plugin that generates a README.md for a Web Component.

Development

# install dependencies
npm install

# start local development
npm start

# run tests
npm test

TIP: When writing custom plugins, ASTExplorer is your friend 🙂

Usage

Install:

npm install --save-dev @github/cem-plugin-readme

Import

custom-elements-manifest.config.js:

import {readme} from '@github/cem-plugin-readme';

export default {
  plugins: [
    readme()
  ]
}