Gitmoji: ✨ Render the README in about page

[johannchopin]

Hello @carloscuesta :sunglasses:!

The about page is 'hard written' has you can see in about.js. I propose to directly render the page using the README file using a markdown parser like showdownjs.

[carloscuesta]

I don't particulary see any benefit to introduce a Markdown renderer for that page.

It's basically the same we have now, there's no any advantage

Adds a lot of complexity to the project for a single page line the about one

[johannchopin]

@carloscuesta Has you said It's basically the same we have now so why don't be sure that it is exactly the same using the README ? If for example we change the Contributing to gitmoji section in the README we should also change it in the about page.

Moreover it will allow the related tools section to be visible on the site directly and adding visibility to the projects that make the gitmoji community grow is a good thing IMHO (#496).

[carloscuesta]

Think we're mixing concepts here. If we decide to move something to the website there's no point for me to maintain it on the README

For now I didn't see a good reason to do this. It is interesting for blogs and documentation sites and that kind of sites.

However for the small amount of pages we have I don't think it's worth the extra effort

There's no need to overengineer the way we do the pages I prefer to favour simplicity

[KaKi87]

You said you're using GitHub Pages, right ? So, GitHub already renders Markdown to HTML

[johannchopin]

@KaKi87 that works for a plain .md files not for markdown rendered from a Javascript file.

[KaKi87]

That's the point, you can just use the README.md file itself.

[johannchopin]

@carloscuesta yes I totally agreed with you considering that simplicity is a key for long terms projects. But isn't #496 a good reason to implement it ? What's your opinion on this issue ?

And personnaly it would be really easy to render the README using a library and will probably replace all this jsx to 5 lines of code (I could probably create a demo PR for that).

[carloscuesta]

I think #496 is something that we should consider. What you're proposing looks good in a way that people could add projects to the JSON file and they could be rendered to the website as we are doing with the Gitmojis.

However I do not think that this issue is related with the #496.

Then the markdown rendering pages generation would only be useful for the about page.

That's why I don't think we need it

---

• index.js: Rendered using JS to HTML with the gitmojis.json file
• contributors.js: Rendered dynamically based on the GitHub API call.
• about.js: Static based on the JS content

If we decide to implement #496 we would have another page that would render based on a JSON file.

You think it's worth then to introduce a different way of generating the pages and rendering them for a single page? Even though it's something easy to implement since there are a ton of solutions out there

[KaKi87]

Also, requiring to edit many files to add the same content should be avoided.

[johannchopin]

I agreed with @KaKi87. What will happen to the related tools section from the README if we implement #496? If we want to add a new tools we should then update the json file and the README for the same content and that's not really great right ? But I also don't want to remove this section from the README since this file as way more visibility than a page in the website.

[carloscuesta]

As I said in https://github.com/carloscuesta/gitmoji/issues/516#issuecomment-660642087

If we decide to move something to the website there's no point for me to maintain it on the README

So we won’t maintain two lists of related tools and projects

[johannchopin]

Yes make sense and would be nicer in a page with css than in the README 👍 lets continue the discussion in #496.

[KaKi87]

If we decide to move something to the website there's no point for me to maintain it on the README

I actually disagree on that one. Considering this tool is related to git, I think more people read the README than the website's about page, plus it requires additional clicks.

[johannchopin]

@KaKi87 but then we could just provide a link to this page in the README. So the README is simpler and easier to read 👍

[carloscuesta]

@KaKi87 The website is way more visited than the Readme page, so there's no point to maintain both sources of information. The project and convention is explained on the website the readme and the repository is made for building the website and the npm package

[vhoyer]

The website is way more visited than the Readme page

but how about the about page for the website? personally, I didn't even realize there was an about page 😅

The project and convention is explained on the website the readme and the repository is made for building the website and the npm package

But I do agree with this, then, 🤷 , let's keep this closed 😄

[johannchopin]

@vhoyer Me too I discovered the about page very late but if we specify the existence of it in the README with a link then it should be fine I guess 👍