github-readme-tech-stack
github-readme-tech-stack copied to clipboard
📚 Add more themes
We'd love to expand our themes with new, cool ones! If you have a fancy theme in mind or would like to see and design new themes, here are simple instructions on how to get started. (Here are the currently available themes.)
Requesting a theme
- Open an issue describing your new theme. If possible, include an image. It can be a theme from another README card project.
- Indicate in the issue if you want someone else to add the theme.
Adding the theme
- Fork the repository
- Clone your fork
- Locate the
themes.ts
file - Set your theme colors using the
themes.set()
function - Add your new theme to the
THEMES.md
file - Commit and push your changes
- Open a Pull Request containing your changes. Please also include a screenshot of your new theme in the PR.
themes.set()
example:
// the theme name should be snake_case
themes.set("theme_name", {
backgroundColor: "#ffffff", // the background color of the card
borderColor: "#ffffff", // the border color of the card
titleColor: "#ffffff", // the title color
badgeColor: "#ffffff", // the background color of the badges
});
Additional context
- Please follow the structure of the code and make sure the spacing and formatting is consistent.
- The theme will not display correctly in THEMES.md until it is deployed, but you can test it locally. Your added theme will be available when your PR is merged.
- Be sure to check the previously added themes to see if a similar (or identical) theme already exists.
- This issue should remain open, please do not mark it as
fixed
.