@emdaer/plugin-contributors-details-github

An emdaer plugin that gathers and renders contributor details from GitHub

Stats

StarsIssuesVersionUpdatedCreatedSize
@emdaer/plugin-contributors-details-github
14293.2.31a year ago4 years agoMinified + gzip package size for @emdaer/plugin-contributors-details-github in KB

Readme

@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

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.