@cheese-grinder/stencil-custom-readme

Stencil Custom Readme

A plugin for StencilJS to add generate custom readme

---

Install

npm install @cheese-grinder/stencil-custom-readme --save-dev

Usage

// stencil.config.ts

import { docsReadme } from '@cheese-grinder/stencil-custom-readme';
import { Config } from '@stencil/core';

export const config: Config = {
  outputTargets: [
    docsReadme()
  ]
};

Contributing

Thanks for your interest in contributing! Please take a moment to read up on our guidelines for contributing. Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.