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

feat: Add README icons #381

Closed
wants to merge 4 commits into from

Conversation

DreepyYunky
Copy link
Contributor

READMEs (eg README.md) are special files, so giving them special icon can help distinct them from, for example, an average markdown file.

The icon is nf-md-information which I think fits since READMEs give information about the thing it's on.

@DreepyYunky DreepyYunky changed the title Add README icons feat: Add README icons Jan 15, 2024
@alex-courtis
Copy link
Member

Holding off pending #376

@DreepyYunky
Copy link
Contributor Author

Holding off pending #376

Ok.

@pauchiner
Copy link
Contributor

@DreepyYunky i think you should also add for .rst README files, these are pretty common in python enviroments

@DreepyYunky
Copy link
Contributor Author

@DreepyYunky i think you should also add for .rst README files, these are pretty common in python enviroments

I even might add for files just named README, no txt or md.

@DreepyYunky
Copy link
Contributor Author

@pauchiner Added .rsts now.

@alex-courtis
Copy link
Member

Sorry, I don't think we should do this: markdown and text are file types, readme is not. web-devicons only handles types, particularly those specified by languages.

That's kind of confirmed by the lack of readme icon in nerd fonts ;)

If you desire special file name handling you can use API override_by_filename

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

Successfully merging this pull request may close these issues.

3 participants