Giter VIP home page Giter VIP logo

dannyverp / markdownprofile Goto Github PK

View Code? Open in Web Editor NEW
32.0 32.0 9.0 3.64 MB

Markdown Profiles is a project that generates markdown files for those that want an awesome Github profile.It provides several templates for you to use.

Home Page: https://markdownprofile.com/

License: Apache License 2.0

JavaScript 89.67% CSS 7.49% SCSS 2.85%
github-page github-profile hacktoberfest markdown markdown-profiles

markdownprofile's Introduction

Danny's Banner

Website
LinkedIn Twitter Medium Dev.To
My Github / Content creation

My name is Danny and I'm an applied university graduated software engineer with a few years of working experience under my belt.

I'm originally from Den Helder πŸ‡³πŸ‡± where I picked up my hobby as lifeguard. I was lucky enough to spend two years in CuraΓ§ao πŸ‡¨πŸ‡Ό and two years in Lisbon πŸ‡΅πŸ‡Ή during my high school time. Eventually I moved to Enschede πŸ‡³πŸ‡± for my studies. Now I spend most of my spare time either developing πŸ–₯️ , playing games 🎲 , swimming 🏊 or teaching lifesaving πŸ‘¨β€πŸ«

My GitHub

Profile statistics

Content creation

Sourav Dey's Blog Cards

markdownprofile's People

Contributors

ankitjuyal009 avatar anup-a avatar dannyverp avatar dependabot[bot] avatar pustur avatar ramadis avatar skodamarthi avatar yash-kulkarni-sf avatar yogeshprasanna avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar

markdownprofile's Issues

🐞Grammerly causes page overvlow

Description:
When using the profile generator and changing the description the page starts overflowing if the Grammarly browser plugin is used.

Device:
Browser: Chrome version 84.0.4147.125 (64-bit) (Engine: Blink)
Operating system: Ubuntu 20.04.1 LTS

Steps to reproduce:

image

Contribution guides and maintaining open source

I'd love some tips, tricks, feedback and guidance on maintaining my first open-source project. I'm currently using a simple example contributing guide. I'd love to have some help formulating a proper contribution guide to the project. If you have any suggestions feel free to add pull requests to the contributing guide or to discuss below.

Make the entire template card clickable

Currently the cards used to select the user's template are only clickable on the select button. There also isn't any hover effect on the card itself. The behaviour of the TemplateSelector component should be changed to have hover styling and to have the entire card be clickable.

πŸ“‹ Add click-to-copy button for markdown

For the generated code section to be more useful a copy-to-clipboard button should be added. In the generated section at the left top, a button should be added that copies the output markdown to the user's clipboard.

image

Open contribution to templates

Welcome to the Markdown Profile open source project!

Have you got an awesome idea for a component which you'd like to offer on the website https://markdownprofile.com then this is your invitation to start contributing! The repository working with NextJS and React and there's a templating structure available to add your ideas. If you need some help please mention me in the issue and I can help you. I'd love to teach you a thing or two or to learn something myself.

Ideas might include:

  • A template which allows the user to dynamically add badges from shield.io;
  • A template which allows the user to post their latest dev.to content;
  • A template which allows the user to post StackOverflow content.

Searching for Github markdown profile on your favourite search engine might even give you more inspiration.

How to contribute

In order to contribute, you can make a fork of the project and submit a pull request. To create a new template:

  • Create a new issue on the repository with a short description of your idea so we can keep track of who's working on which idea.
  • Check out the ReadMe file to find out how to start developing.
  • Create a new template class component in the templates directory. Check out the other templates for examples of how to structure your template.
  • Add your class component to the index.js file in the template directory.
  • Your template should now render on the page.
  • Commit, push and submit your awesome MR πŸš€

List contributors on site

It would be nice to show those that have contributed to the project somewhere on the site. I was thinking of putting a section in the footer where the profile pictures of the contributors (retrieved from Github) would be shown.

Dynamic height card titles, images, authors and description for template selectors

Description

Currently, the selection card displays quite weirdly in terms of height. The height of the images is a fixed height which causes them to stretch. The description and title fields can also cause the card to not align properly. Ideally, each field in the card should be the same height compared to the other card. This way the titles, images, authors and descriptions will line up neatly with each other.

Steps to reproduce

  • Open the page on any resolution which displays two cards next to each other.
  • Notice the difference in title, image, description and author heights.
  • Notice the weird stretch in the images

Screenshots

image

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    πŸ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. πŸ“ŠπŸ“ˆπŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❀️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.