Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ceoshikhar/better-github
Enhance your code reading experience on GitHub.
https://github.com/ceoshikhar/better-github
browser-extension chrome-extensions firefox-addon github github-font
Last synced: 13 days ago
JSON representation
Enhance your code reading experience on GitHub.
- Host: GitHub
- URL: https://github.com/ceoshikhar/better-github
- Owner: ceoshikhar
- License: mit
- Created: 2021-01-02T10:59:09.000Z (almost 4 years ago)
- Default Branch: main
- Last Pushed: 2022-02-09T20:56:29.000Z (almost 3 years ago)
- Last Synced: 2024-10-24T21:28:01.230Z (21 days ago)
- Topics: browser-extension, chrome-extensions, firefox-addon, github, github-font
- Language: JavaScript
- Homepage:
- Size: 8.69 MB
- Stars: 45
- Watchers: 3
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# Demo
# Get the extension
### [Firefox](https://addons.mozilla.org/en-US/firefox/addon/bettergithub/)
### [Chrome](https://chrome.google.com/webstore/detail/better-github/ammeaejgjdeifjekkofhnliedhccbmgp)
# Features
### Simple interface to use the extension
`Better Github` allows you to apply custom fonts and modify font size of code text. These styles are applied to :
> Example below have the following Better GitHub's config: `Font Name` is [Hack](https://github.com/source-foundry/Hack) and `Font Size` is **14**.
- All the text inside a file while viewing( reading ) it.
- Code in README files that are inside "``" blocks also known as `` tags.
- Code in pull request diffs.
**Note:** If the custom styles are not applied( it can happen sometimes ), refresh the page.
# Motivation
Default font size of code text was very small which gave me had a hard time reading code in any repository and in PR diffs. I also wanted my code editor font and GitHub font to be same.
Couldn't find anything existing to help me solve my problem, so I created this simple yet powerful extension for Chrome browser. If something does exist though, let me know, alright?
I called it `Better GitHub` inspired by `Better Twitch TV` and `Better Discord`.
# Todos
> Context: I created this list of tasks after I decided to make this extension public. Initially the code was very small and the font styles were hard coded. If I needed to modify the styles, I had to change it in the source code, reload the extension and refresh GitHub pages to reflect the updates. Consider this list as the roadmap for the project.
- [x] Instead of hard coding the `fontFamily` and `fontSize`, we should be able to allow the user to choose a font size and font family of their choice (which they have installed on their machine).
- [x] Create a browser action popup to show an interface to allow the user to customise their extension's settings for `fontFamily` and `fontSize`.
- [x] Integrate browser action popup with chrome API to persist and read user's settings for `fontFamily` and `fontSize` from and to the storage.
- [x] Apply styles without reloading whenever the settings are changed from the browser action popup interface.
- [x] If no custom font styles are set, load GitHub's default font styles.
- [x] User can reset font styles to GitHub's default font styles.
- [x] Add GIF to show the usage( demo ) of the extension.
- [x] Installation instructions on how to clone/download this repository, install the extension and use it.
- [x] Logo for the extension that will be used as favicon, icon, in documentation etc.
- [x] Firefox support as it was requested by [others](https://dev.to/ceoshikhar/enhance-your-code-reading-experience-on-github-with-this-chrome-extension-24ei).
- [x] Publish it as an official Mozilla Firefox addon.
- [x] Publish it as an official Chrome extension on Chrome Web Store.
- [x] Allow user to change only one property instead of all properties being mandatory.
- [ ] Add `CONTRIBUTING.md` to help others so that they can contribute to the project.