Github-Cards-Api

Table of Contents

• Github-Cards-Api
  • Table of Contents
  • Usage
    • Using Markdown
    • Using HTML
  • Available Cards
  • Themes
    • Options
    • Custom Arguments
    • Examples
  • Contributing
    • Adding a New Card
    • Adding a New Theme
  • Additional Information

Usage

Visit the following endpoint URL for all available cards and their respective options:
https://afraid-ninnetta-github-cards.koyeb.app/

You can embed one of the available cards in your README using either Markdown OR HTML:

Using Markdown

<!-- Markdown -->
![Card](https://afraid-ninnetta-github-cards.koyeb.app/any_card_name)

Using HTML

<!-- HTML -->
<img src="https://afraid-ninnetta-github-cards.koyeb.app/any_card_name" alt="Card" />

Available Cards

Here is a list of cards that can currently be used:

Available Cards	Example
jokes-card	
programming-quotes-card	
motivational-quotes-card	
word-of-the-day-card	
challenge-of-the-week-card	
team-work-quote-card	
bhagavad-geeta-card	
random-card	
programming-facts-card	
top-tweets-card	
spanish-quote-card	
fun-fact-card	
github-facts-card	
random-facts-card	
harry-potter-spell-card	
breaking-bad-quote-card	
got-quotes-card	
security-tips-card	
french-word-of-the-day-card	
travel-destinations-card	
health-tip-card	

Themes

Options

You can customize the appearance of the cards by selecting one of the following themes:

1. light
2. dark
3. dark_2
4. rgb
5. lemonade
6. pattern_1
7. pattern_2
8. pattern_3
9. random - A random theme from those listed above will be applied
10. custom - You may set your own custom arguments

NEW HTML THEMES (LIMITED TO HTML CARDS)

1. techy
2. neon_horizon
3. (More coming soon...)

Custom Arguments

If you choose the custom theme, you can configure the card with the following arguments:

args: {
    card_color: "Card color. Default: #ffffff  [Optional]",
    font_color: "Card text color. Default: #000000  [Optional]",
    bg_color: "Card Background color. Default: #fff  [Optional]",
    shadow: "Card shadow. Default: false  [Optional]",
    shadow_color: "Card shadow color. Default: #000000  [Optional]",
},

Examples

• Light Theme Card

  

• Dark Theme Card

  

• Dark_2 Theme Card

  

• Rgb Theme Card

  

• Lemonade Theme Card

  

• Galaxy Theme Card

  

• Pattern_1 Theme Card

  

• Pattern_2 Theme Card

  

• Pattern_3 Theme Card

  

• Techy Theme Card

  (Limited to HTML Cards)
  

• Neon_Horizon Theme Card

  (Limited to HTML Cards)
  

Contributing

Adding a New Card

1. Fork this repository.
2. Add your card in the src/cards directory. You can refer to the existing cards for guidance.
3. If your card needs data, add a file inside the data directory (supported languages: English and Hindi).
4. Add a route for your card in the index.js file.
5. Update the src/help.js file and the README with your new card's API reference.
6. Create a pull request.
7. Ensure your data file has at least around 100 entries.

You can also create cards in HTML and CSS! Check out the src/cards/motivational-quote.js file to see how cards are generated with unique styles using HTML and Satori. Refer to the official Satori documentation here for supported CSS properties.

Adding a New Theme

1. Fork this repository.
2. If you want to add a gradient background, add your gradient code in src/gradients.js (refer to the existing gradients).
3. Add your theme name to the src/themes.js file, placing it second-to-last in the array and ensuring the name is unique.
4. Define your theme in src/themes.js (refer to existing themes for structure).
5. Update the src/help.js file and the README with your new theme's API reference.

Contributing Guidelines

• Ensure your code is properly formatted and follows the existing code style.
• Ensure your code is well-commented and tested before creating a pull request.
• Ensure your card/theme is unique and not a duplicate of an existing card/theme.
• Ensure your card/theme is not offensive or inappropriate.
• Do not commit package-lock.json, yarn.lock, package.json, or any other unnecessary files.

Additional Information

For more information, visit https://afraid-ninnetta-github-cards.koyeb.app/.