cuban-opensource icon indicating copy to clipboard operation
cuban-opensource copied to clipboard

Json data model

Open glpzzz opened this issue 6 years ago • 6 comments
trafficstars

I added a new branch were the data is stored in a json file and from it we generate the readme.md file

The idea is also generate a GitHub page with this data to get more visibility .

Ideas?

glpzzz avatar Jul 07 '19 06:07 glpzzz

And maybe an RSS generator? In this way, users don't need a github account to stay updated.

PhaserEditor2D avatar Jul 08 '19 03:07 PhaserEditor2D

Nice idea! One thing you can do is to set up Travis on this repository, so whenever you change the JSON file, then Travis will generate the README.md file and push it back. See a helpful gist here. In the same way you can also generate an html file and create a gh-pages, docs folder or even place the file in the master branch to use Github Pages see these instructions. The RSS generator proposed by @PhaserEditor2D can be implemented in this way too.

oscarlvp avatar Jul 08 '19 09:07 oscarlvp

All good ideas, i would suggest using YAML instead of json, it is shorter, more readable and easier to edit. You can see an example in https://github.com/starbelly/erlang-companies/blob/master/src/_data/companies.yml, they use it to generate a GitHub page

codeadict avatar Jul 17 '19 17:07 codeadict

All good ideas, i would suggest using YAML instead of json, it is shorter, more readable and easier to edit. You can see an example in https://github.com/starbelly/erlang-companies/blob/master/src/_data/companies.yml, they use it to generate a GitHub page

Never used YAML before. Can you write the script to create the readme.md at least?

glpzzz avatar Jul 19 '19 21:07 glpzzz

I like the idea of using YAML instead of json it is more readable for humans

aleGuardiola avatar May 11 '20 21:05 aleGuardiola

We use YAML in this website: https://www.videojuegoscuba.org/

Here the repo: https://github.com/GameDev-Cuba/creadores-cubanos-videojuegos-website

Baiscally, it uses a static site generator.

BTW, that site was inspired by this one 😉

PhaserEditor2D avatar Sep 19 '22 18:09 PhaserEditor2D