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

Add additional metadata to GitHub repos #182

Open
2 tasks
jerboa88 opened this issue Jan 29, 2025 · 0 comments · Fixed by #192
Open
2 tasks

Add additional metadata to GitHub repos #182

jerboa88 opened this issue Jan 29, 2025 · 0 comments · Fixed by #192
Assignees
Labels
✨ feature New feature or request 🚦 in progress Issue is being worked on 🚩 medium

Comments

@jerboa88
Copy link
Owner

jerboa88 commented Jan 29, 2025

We can use fake markdown references to store additional metadata in the README without showing it normally like so:

[meta:exposition]: # (My personal/portfolio site. Made by hand using Gatsby, React, and Tailwind CSS, this static site fetches repository data from the GitHub GraphQL API to display a selection of my public repositories on the home page. This project was a great opportunity to learn more about TypeScript, React, and the GraphQL Data Layer.)
[meta:category]: # (Website)
[meta:technologies]: # (Gatsby, React, Tailwind CSS, daisyUI)
[meta:tools]: # (Git, GitHub, Linux)
[meta:topics]: # (OOP)
[meta:schema:type]: # (WebSite)
[meta:schema:applicationCategory]: # (Website)
[meta:schema:operatingSystem]: # (All)
  • In the README of every GitHub repo:
    • Add this metadata
    • Update the URL of the project category badge to the new one hosted on https://johng.io
    • Remove the old data-exposition attribute
  • Update the default README template
@jerboa88 jerboa88 added 🚦 new Issue has not been investigated yet ✨ feature New feature or request 🚩 medium labels Jan 29, 2025
@jerboa88 jerboa88 self-assigned this Feb 7, 2025
@jerboa88 jerboa88 added 🚦 confirmed Issue has been reproduced 🚦 in progress Issue is being worked on and removed 🚦 new Issue has not been investigated yet 🚦 confirmed Issue has been reproduced labels Feb 7, 2025
@jerboa88 jerboa88 linked a pull request Feb 7, 2025 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
✨ feature New feature or request 🚦 in progress Issue is being worked on 🚩 medium
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant