@emdaer/plugin-contributors-details-github

3.2.31 • Public • Published

@emdaer/plugin-contributors-details-github · Travis Documented with emdaer Maintained with lerna

An emdaer plugin that gathers and renders contributor details from GitHub

Usage

@emdaer/plugin-contributors-details-github is an emdaer plugin – see the emdaer monorepo for more information

Documentation

Example

Contributors
Luke Herrington

Usage in README

Use @emdaer/plugin-contributors-details-github to create a collapsible contributors list like so:

<!--emdaer-p
  - '@emdaer/plugin-contributors-details-github'
-->

contributorsDetailsPlugin

A plugin to generate details

Parameters

  • options any
    • options.path string? The path to the contributors list (optional, default DEFAULT_PATH)
    • options.title string? The title of the details summary (optional, default DEFAULT_SUMMARY_TITLE)

Examples

<!--emdaer-p
  - '@emdaer/plugin-contributors-details-github'
-->

Returns Promise<string> The details element

Dependencies (3)

Dev Dependencies (1)

Package Sidebar

Install

npm i @emdaer/plugin-contributors-details-github

Weekly Downloads

168

Version

3.2.31

License

MIT

Unpacked Size

46.5 kB

Total Files

12

Last publish

Collaborators

  • beautyhammer
  • emdaerbot
  • flipactual
  • infiniteluke