kautukkundan / Awesome-Profile-README-templates

A collection of awesome readme templates to display on your profile
10.75k stars 7.44k forks source link

Create a website for the project #77

Open saadpasta opened 4 years ago

saadpasta commented 4 years ago

@kautukkundan amazing work on the repo🔥. Currently, it's hard to look at the readme.md, we have to navigate through all the folder to look at them we could make a website for that using Gatsby that will help fetch readme's and show on the website. We could also use that to generate a thumbnail for the readme so the user can have a look at the readme beforehand

We could further break down readme in Trending Most Liked and much more.

kautukkundan commented 4 years ago

Hey @saadpasta That's a great idea, building a website is in pipeline since a long time, however I am a little caught up between other things. I'll do that very soon. If you want, you can also try it out and send a PR maybe?

cristianmarint commented 4 years ago

@kautukkundan Are you willing to consider a PR with Gohugo (Static Site Generator)?

kautukkundan commented 4 years ago

yes definitely! Infact I did try experimenting with Hugo. It required contributor to additionally add their links in the "sidebar". Will it be a lot of work for the contributor? Will it make it difficult to contribute? what do you think? If this is possible and/or there's a better way, then please suggest.

98lenvi commented 4 years ago

@kautukkundan How about using Gatsby? We will just require the users to add the following on top of the .md file

---
title: 'README template name'
date: "2020-03-20T22:40:32.169Z"
description: README template description.
---

Contributors will only have to create a pull request for their readme.md file (with the above details in the same file), the later will be taken care of by the template (you can check my web site's source code)

All the PRs would be adding a folder (with a .md file) to the content/blog folder

kautukkundan commented 4 years ago

Oh that sounds doable. If you're free can you add this and make a PR in a new branch "static-site" or something? Else I'll check it out on sunday.

98lenvi commented 4 years ago

@kautukkundan I will do it tonight.I will not focus heavily on styling, We can collaborate & focus on styling after the PR.

cristianmarint commented 4 years ago

@98lenvi Sounds great! I will also suggest something along the lines of

---
.
.
.
category: (...)
featured: true or false (So popular profiles can be display on mainpage)
github-username(or url): (...)
---

Also is Disqus integration for generate interaction doitable?

98lenvi commented 4 years ago

@cristianmarint Well, I figured out that we have 73 existing README already there (and many more in pending PRs) and updating all that with the comment for title, date & description is going to be difficult, So I skipped it. Disqus is very doable.

All the pages are programmatically created based on the folder & file name.

VinayVeerappaji commented 4 years ago

It'll be good if the website displays the raw markdown format and I'll be willing to submit a PR for it.

98lenvi commented 4 years ago

@VinayVeerappaji, It's a great idea since everyone will be able to just copy-paste the README markdown from the website and use it (without ever having to visit the GitHub repository). I think you can get started with it once my PR gets merged.

VinayVeerappaji commented 4 years ago

Yes, you understood my point @98lenvi. So others can able to use the same by simply modifying it.

piyushxbajaj commented 4 years ago

Hi I loved reading this read.☺️ Wanted to know how the website building is going?

Alan-Barreto-Batista commented 4 years ago

Em seg, 27 de jul de 2020 00:53, Piyush notifications@github.com escreveu:

Hi I loved reading this read.☺️ Wanted to know how the website building is going?

— You are receiving this because you are subscribed to this thread. Reply to this email directly, view it on GitHub https://github.com/kautukkundan/Awesome-Profile-README-templates/issues/77#issuecomment-664105089, or unsubscribe https://github.com/notifications/unsubscribe-auth/AQH2M6SZAFFD2PMWZXH4QHDR5T24BANCNFSM4O2LJ5WQ .

sudnyeshtalekar commented 4 years ago

Really great idea of building website for all these profiles.Loved reading the conversation.How's the website build going??