Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Switch table generation to HTML #154

Closed
jakebolam opened this issue Jan 27, 2019 · 4 comments · Fixed by #157
Closed

Switch table generation to HTML #154

jakebolam opened this issue Jan 27, 2019 · 4 comments · Fixed by #157

Comments

@jakebolam
Copy link
Collaborator

jakebolam commented Jan 27, 2019

Been looking to improve the look of the table. Indirectly as part of other tickets (https://github.com/all-contributors/all-contributors-bot/issues/101)

Is there any strong reason for staying with markdown? Or could we switch the table generation over to HTML (in a breaking_change release) ?

Reasons for switching to HTML:

  • Improving the table layout on all-screens/devices
  • Additional customization of the table (e.g. colspan, width control etc)

Reasons for sticking with Markdown

  • Possible projects using website generators from markdown that have the table?
@jakebolam
Copy link
Collaborator Author

@kentcdodds do you know if there were any reasons for using markdown with the auto-generate tools?

@kentcdodds
Copy link
Collaborator

Happy to see it improved. Either way works.

@jakebolam jakebolam added this to In progress in All Contributors Kanban Jan 27, 2019
@jakebolam jakebolam moved this from In progress to To do in All Contributors Kanban Jan 27, 2019
@Berkmann18
Copy link
Member

I'll give this a go and see what I get.

Berkmann18 added a commit that referenced this issue Jan 29, 2019
I added and set the HTML generator for resolving #154 (which works when testing manually but doesn't
when running the cli in dev mode).

fix #154
@jakebolam jakebolam moved this from To do to In progress in All Contributors Kanban Feb 3, 2019
All Contributors Kanban automation moved this from In progress to Done Feb 6, 2019
jakebolam pushed a commit that referenced this issue Feb 6, 2019
*BREAKING CHANGE*

* style(generate): changed generator to an HTML based one [WIP]

I added and set the HTML generator for resolving #154 (which works when testing manually but doesn't
when running the cli in dev mode).

fix #154

* refactor(generate): (re)moved files to keep it DRY

* refactor: refactored/updated tests

Update the contributors test (which wasn't already committed somehow) and tweaked the
`format-contribution-type` test.

* docs(readme): removed doctoc

BREAKING CHANGE: (in 2babe26) The resulting contributors table is in HTML/CSS instead of being in Markdown.

* refactor(generate): removed the style from the generation

Removed the `<style>` block from the generated HTML code as it's redundant on Github (since it's one
of the non-whitelisted tags). The `README.md` was also updated reflecting the breaking changes.

* refactor(generate): image height and tweaks

Added `height` to images for avatars, quoted some `<table>` attributes and updated `README.md`

* docs: drop TOC
@all-contributors-release-bot
Copy link
Member

🎉 This issue has been resolved in version 6.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Berkmann18 pushed a commit that referenced this issue May 24, 2020
* fix(package): update all-contributors-cli to version 6.1.2

Closes #137

* chore(package): update lockfile yarn.lock

* Update snapshot
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
No open projects
Development

Successfully merging a pull request may close this issue.

4 participants