feat: add wrapperTemplate option
#348
Conversation
jdalrymple
changed the title
|
Posted the PR to look for any feedback while i fill in the rest of the checklist! |
|
Where are the docs located? 🤔 |
jdalrymple
changed the title
@jdalrymple docs are in https://github.com/all-contributors/all-contributors. |
There was a problem hiding this comment.
@jdalrymple Thanks for this contribution. Please provide a working example for this one so we can compare. Also, I'm unsure about using other parent tags besides <table>. We also need to check the browser compatiblity.
|
Can do! The primary reason for the option to change the wrapper tag is because of the styling limitations within markdown linked to the table tag. For example in that issue, the desire to have a minimalist list of contributors such as:
Can only be accomplished with either styling (which isnt supported in github markdown) or changing the tag used to wrap the content. I was able to accomplish this example with p tag instead of the table tag, however knowing that things should not be hardcoded, i figured using a configurable option would be the way to go. Ill post up a sample repo ASAP! |
|
|
|
Is there anything else that i need to address for this to be merged? |
gr2m
changed the title
wrapperTemplate option
|
@all-contributors add @jdalrymple for code and test |
|
I've put up a pull request to add @jdalrymple! 🎉 |
|
🎉 This PR is included in version 6.25.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
What: Adding support for a wrapper template that allows for a minimalist version of the contributors log. See original issue
Why: Modified the wrapping template from the defaulted 'table' to what ever the user supplies in their configuration
How: A simple if during the generation of the list wrapping. For a working sample, check this repo. After running the install, you may need to run
yarn buildfrom within the node_modules/all-contributors-cli directory to have access to the cli commands.Checklist: