UNPKG

@emdaer/plugin-contributors-details-github

Version:

An emdaer plugin that gathers and renders contributor details from GitHub

62 lines (51 loc) โ€ข 1.43 kB
# <!--emdaer-p - '@emdaer/plugin-value-from-package' - value: name --> ยท <!--emdaer-p - '@emdaer/plugin-shields' - shields: - alt: 'Travis' image: 'travis/emdaer/emdaer.svg' link: 'https://travis-ci.org/emdaer/emdaer/' style: 'flat-square' - alt: 'Documented with emdaer' image: 'badge/๐Ÿ““-documented%20with%20emdaer-F06632.svg' link: 'https://github.com/emdaer/emdaer' style: 'flat-square' - alt: 'Maintained with lerna' image: 'badge/๐Ÿ‰-maintained%20with%20lerna-cc00ff.svg' link: 'https://lernajs.io/' style: 'flat-square' --> <!--emdaer-p - '@emdaer/plugin-value-from-package' - value: description --> ## Usage <!--emdaer-p - '@emdaer/plugin-value-from-package' - value: name --> is an [emdaer](https://github.com/emdaer/emdaer/) plugin โ€“ see the [emdaer monorepo](https://github.com/emdaer/emdaer/) for more information ## Documentation ### Example <!--emdaer-p - '@emdaer/plugin-contributors-details-github' --> ### Usage in README Use `<!--emdaer-p - '@emdaer/plugin-value-from-package' - value: name -->` to create a collapsible contributors list like so: ```md <!--emdaer-p - '@emdaer/plugin-jsdoc-tag-value' - source: ./src/index.js functionName: contributorsDetailsPlugin tag: example --> ``` <!--emdaer-p - '@emdaer/plugin-documentation' - sources: - ./src/index.js -->