Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Json data model #27

Open
glpzzz opened this issue Jul 7, 2019 · 6 comments
Open

Json data model #27

glpzzz opened this issue Jul 7, 2019 · 6 comments

Comments

@glpzzz
Copy link
Member

glpzzz commented Jul 7, 2019

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?

@PhaserEditor2D
Copy link
Contributor

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

@oscarlvp
Copy link

oscarlvp commented Jul 8, 2019

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.

@codeadict
Copy link
Contributor

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

@glpzzz
Copy link
Member Author

glpzzz commented Jul 19, 2019

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?

@aleGuardiola
Copy link
Contributor

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

@PhaserEditor2D
Copy link
Contributor

PhaserEditor2D commented Sep 19, 2022

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 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

5 participants