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

[Feature request] Add Markdown (*.md) to be at Top Language and Top Repo #201

Open
thenocturnaldevgypsy-io opened this issue Nov 1, 2024 · 1 comment

Comments

@thenocturnaldevgypsy-io
Copy link

thenocturnaldevgypsy-io commented Nov 1, 2024

Context

I've noticed that Markdown (*.md) is not included in Top Language and Top Repo. I know that it sounds weird to request for it, but for technical writers who uses MD files for their documentation (aside the built in Wiki) here in GitHub and for those who uses GitHub Action workflows and embedding those in the MD files they're working on, I think it would be worth it to be shown in the stats? 😅

Alternatives

It's currently attainable using anuraghazra/github-readme-stats's WakaTime Stats Card , but it's more on how many hours you've spent on it, I would like/love to switch to your stats card as it's more compact friendly.

Has the feature been requested before?

I tried searching both open and closed issue tickets, there's none,

If the feature request is approved, would you be willing to submit a PR?

Yes, 50/50? But I might need help on this, as I've tried deploying it to my local but I can't seem to make it work lol.

@vn7n24fzkq
Copy link
Owner

Thank you for the suggestion! 😊

I agree that documentation contributions are just as important as code, especially for technical writers and documentation-heavy projects. GitHub does support markdown through Linguist, as you mentioned (see Linguist configuration here), so Markdown can technically be detected. However, if GitHub doesn’t recognize Markdown as a primary language for a repository, we won’t be able to factor it into the language statistics directly.

Proposal Considerations

  1. Implementation: We’d need to investigate how to capture Markdown's presence reliably, especially when GitHub’s native detection doesn’t list it as a primary language. Adjusting our language parsing logic to include Markdown when relevant could be one way to address this, though we’d need to ensure it doesn’t inadvertently overshadow code languages.

  2. User Settings: An opt-in feature might be a good approach, allowing users who prioritize Markdown to activate it in their stats configuration without affecting others who may not need it.

  3. Top Repo with Markdown: We could also consider adding Markdown-dominant repositories to the Top Repo section for users who work heavily in documentation or maintain static sites.


This will require some investigation to determine the best implementation approach. If the request gains interest from the community, feel free to open a PR, and we can assist with the setup! Given the setup challenges you mentioned, we’d be happy to help get you up and running if you’re up for contributing. 😊

Let’s keep this open for further discussion and community feedback. Thanks again for the idea—it could be a valuable addition for expanding the tool’s accessibility!

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

2 participants