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 more themes #45

Open
0l1v3rr opened this issue Jan 6, 2023 · 0 comments
Open

📚 Add more themes #45

0l1v3rr opened this issue Jan 6, 2023 · 0 comments
Labels
enhancement New feature or request good first issue Good for newcomers pinned Pinned issues

Comments

@0l1v3rr
Copy link
Owner

0l1v3rr commented Jan 6, 2023

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

  1. Open an issue describing your new theme. If possible, include an image. It can be a theme from another README card project.
  2. Indicate in the issue if you want someone else to add the theme.

Adding the theme

  1. Fork the repository
  2. Clone your fork
  3. Locate the themes.ts file
  4. Set your theme colors using the themes.set() function
  5. Add your new theme to the THEMES.md file
  6. Commit and push your changes
  7. 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.
@0l1v3rr 0l1v3rr added enhancement New feature or request good first issue Good for newcomers pinned Pinned issues labels Jan 6, 2023
@0l1v3rr 0l1v3rr pinned this issue Jan 6, 2023
Repository owner deleted a comment from Rotimiiam Feb 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers pinned Pinned issues
Projects
None yet
Development

No branches or pull requests

2 participants
@0l1v3rr and others