Github action generates dynamic image URL for contributor list to display it!
The contributors list is fetched from GitHub API.
As always, thanks to our amazing contributors!
Write contributors(htmlTable
) to markdown Example:
Bot Users:
Collaborators Users:
Write contributors(htmlList
) to markdown Example:
- run: mkdir -p build - name: Generate Contributors Images uses: jaywcjlove/github-action-contributors@main with: filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\]) output: build/CONTRIBUTORS.svg avatarSize: 42 - name: Deploy uses: peaceiris/actions-gh-pages@v3 with: github_token: ${{ secrets.GITHUB_TOKEN }} publish_dir: ./build
https://jaywcjlove.github.io/github-action-contributors/CONTRIBUTORS.svg
Use in markdown
## Contributors As always, thanks to our amazing contributors! <a href="https://github.com/jaywcjlove/github-action-contributors/graphs/contributors"> <img src="https://jaywcjlove.github.io/github-action-contributors/CONTRIBUTORS.svg" /> </a> Made with [contributors](https://github.com/jaywcjlove/github-action-contributors).Write contributors(
htmlList
) to markdown
- name: Generate Contributors Images uses: jaywcjlove/github-action-contributors@main id: contributors with: filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\]) avatarSize: 42 - name: Modify README.md uses: jaywcjlove/github-action-modify-file-content@main with: path: README.md body: '${{steps.contributors.outputs.htmlList}}'
Use in README.md
markdown
## Contributors As always, thanks to our amazing contributors! <!--GAMFC--><a href="https://github.com/jaywcjlove" title="小弟调调"><img src="https://avatars.githubusercontent.com/u/1680273?v=4" width="36;" alt="小弟调调"/></a><!--GAMFC-END--> Made with [contributors](https://github.com/jaywcjlove/github-action-contributors).
Write contributors(htmlList
) to markdown Example:
htmlTable
) to markdown
- name: Generate Contributors Images uses: jaywcjlove/github-action-contributors@main id: contributors with: filter-author: (renovate\[bot\]|renovate-bot|dependabot\[bot\]) openDelimiter: '<!--GAMFC_DELIMITER-->' closeDelimiter: '<!--GAMFC_DELIMITER-END-->' hideName: 'true' # Hide names in htmlTable avatarSize: 100 # Set the avatar size. - name: Modify htmlTable README.md uses: jaywcjlove/github-action-modify-file-content@main with: path: README.md body: '${{steps.contributors.outputs.htmlTable}}'
Use in README.md
markdown
## Contributors As always, thanks to our amazing contributors! <!--GAMFC_DELIMITER-->will be replaced here<!--GAMFC_DELIMITER-END--> Made with [contributors](https://github.com/jaywcjlove/github-action-contributors).
Write contributors(htmlTable
) to markdown Example:
Bot Users:
token
- Your GITHUB_TOKEN
. This is required. Why do we need token
? Read more here: About the GITHUB_TOKEN secret. Default: ${{ github.token }}
filter-author
- Regular expression filtering'.count
- Specify the max count of contributors listed. Default list all contributors(max 100).output
- output image path. default: CONTRIBUTORS.svg
truncate
- Truncate username by specified length, 0
for no truncate. default: 12
svgWidth
- Width of the generated SVG. default: 740
avatarSize
- Size of user avatar. default: 24
avatarMargin
- Margin of user avatar. default: 5
hideName
- Hide names in htmlTable
userNameHeight
- Height of user name. default: 0
svgTemplate
- Template to render SVG.<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" width="{{ width }}" height="{{ contributorsHeight }}" > <style>.contributor-link { cursor: pointer; }</style> {{{ contributors }}} </svg>
svg
svg image string: <svg xmlns....
.htmlTable
Contributor HTML <Table> form stringhtmlTableBots
Contributor(Bot Users) HTML <Table> form stringhtmlList
Contributor HTML <a> list form stringhtmlListBots
Contributor(Bot Users) HTML <a> list form stringhtmlCollaboratorsTable
Collaborators user HTML form stringhtmlCollaboratorsTableBots
Collaborators user(Bot Users) HTMLhtmlCollaboratorsList
Collaborators user HTML list form stringhtmlCollaboratorsListBots
Collaborators user(Bot Users) HTML form string<table> <tr> <td align="center"> <a href="https://github.com/jaywcjlove"> <img src="https://avatars.githubusercontent.com/u/1680273?v=4" width="36;" alt="jaywcjlove"/><br /> <sub><b>jaywcjlove</b></sub> </a> </td> </tr> </table>
<a href="https://github.com/jaywcjlove"> <img src="https://avatars.githubusercontent.com/u/1680273?v=4" width="36;" alt="jaywcjlove"/> </a> <a href="https://github.com/github-actions[bot]"> <img src="https://avatars.githubusercontent.com/in/15368?v=4" width="36;" alt="github-actions[bot]"/> </a
$ npm install $ npm run watch # Listen compile .ts files. $ npm run build # compile .ts files.
package.json
.As always, thanks to our amazing contributors!
Made with contributors.
Licensed under the MIT License.
RetroSearch is an open source project built by @garambo | Open a GitHub Issue
Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo
HTML:
3.2
| Encoding:
UTF-8
| Version:
0.7.4