https://github.com/cheesegrinder/stencil-custom-readme

Plugin made for stencilJS to make custom readme
https://github.com/cheesegrinder/stencil-custom-readme

custom documentation plugin readme stencil

Last synced: 8 days ago
JSON representation

Plugin made for stencilJS to make custom readme

• Host: GitHub
• URL: https://github.com/cheesegrinder/stencil-custom-readme
• Owner: CheeseGrinder
• License: mit
• Created: 2024-03-22T16:04:26.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-08-15T11:50:47.000Z (3 months ago)
• Last Synced: 2024-08-21T10:21:22.210Z (3 months ago)
• Topics: custom, documentation, plugin, readme, stencil
• Language: TypeScript
• Homepage:
• Size: 93.8 KB
• Stars: 0
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Audit: audit-ci.json
  • Security: SECURITY.md

Awesome Lists containing this project

README

        


  

    

  





  Stencil Custom Readme





A plugin for [StencilJS][stencil-site] to add generate custom readme





  

    

  

  

    

  



---------

### Install

```bash

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

```

### Usage

```ts

// 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][contributing].

Please note that this project is released with a [Contributor Code of Conduct][code-of-conduct]. By participating in this project you agree to abide by its terms.

[stencil-site]: https://stenciljs.com/

[contributing]: https://github.com/CheeseGrinder/stencil-custom-readme/blob/main/CONTRIBUTING.md

[code-of-conduct]: https://github.com/CheeseGrinder/stencil-custom-readme/blob/main/CODE_OF_CONDUCT.md