Add Contributor Highlights in the docs

[DavidLambauer]

[DavidLambauer]

We currently have a Table of Contents Markdown Extension, which allows us to put [TOC] directly into an MD file and generate a proper table of contents.

I'd love to have a similar mechanism for the contributor highlights. A highlight must contain the contributor's name and link to his GitHub Account.

Something like [highlight, @DavidLambauer] would be nice

This is a good starting point: https://commonmark.thephpleague.com/2.4/extensions/mentions/

[laurali123]

Hey @nlardev-hublot ,
we have made some design suggestions for the contributor part (if it's not too late - how far have you already come?)
Feel free to look at them and tell us what you think and if you can manage to implement them?

1. Top Section

• Add text field
• the text is in cursive and color #ff6700
• the text has an anchor link that scrolls to the end of the page to the new added section "contributor"
• Add an icon in the navigation section: https://shorturl.at/sEGKL
• Set a anchor link on the icon that scrolls you to the end of the page where a contributor section is found

2. Bottom Section Contributor

• Add a contributor content block where a short "thanks"-sentence shows up
• Place a contributor gitlab section underneath it
• Get dynamically the gitlab users' profile image and company name

3. Bottom Section - Give a thanks to the contributor

• Add a text block
• Place beside it a "thank you" section where the readers can leave a "thank you" by clicking on the icon/button
• After users have clicked on the button, the buttons counter addes for each click a number to visualize how many people have stayed "thanks"
• we even thought of animations after clicking the "thanks" icon, like the hand-icon flying through the screen (but that's really fancy, I know... :D )

[nikolalardev]

Thank you @laurali123 will work on it.

[nikolalardev]

@DavidLambauer @laurali123
1. Top Section

• I will need the icon in svg format to be able to add it. The svg download is not free :(

2. Bottom Section Contributor

• About the github name and company - we will need to get this information thru github api. https://docs.github.com/en/rest/users/users?apiVersion=2022-11-28 . I guess @DavidLambauer will provide the token, I don't know who is taking care for credentials in the MageOs organisation.
• Name and Company field can be empty in github account of the user, if name is empty we can display username.
• Should I used this design for images https://mage-os.org/about/contributors/

3. Bottom Section - Give a thanks to the contributor

• At the moment the documentation website is without database, we should find way to keep the "thanks" counter somewhere. @DavidLambauer

[DavidLambauer]

HI @nikolalardev, I will provide a token once it is merged.

Name and Company field can be empty in github account of the user, if name is empty we can display username.

Good!

Should I used this design for images https://mage-os.org/about/contributors/

Yes, why not!

For the "Thanks" Section, it might be clever to just refer to get a membership of Mage-OS instead of having these clapping hands. The counter doesn't add any value and this would be a good opportunity to highlight the memberships more a bit.

[DavidLambauer]

@laurali123 You take care of the SVG, yeh?

[laurali123]

@nikolalardev I changed the icon to a similar one, which is available for free, has no copyright and comes as a SVG file:
https://www.svgrepo.com/svg/49757/clap