Generate SVG styled proverbs
- Description
- How to use
- Example
- Visitor stats
- Licensing
- Authors
- Versioning
- Contribution
- Acknowledgement
- Forks
- Issues
- Team Tools
- OpenGraph Card
- Development Support
Styled proverbs is a serverless function that generates dynamically styled proverb images based on SVG (Scalable Vector Graphics). For the tech stack, Styled proverbs using Typescript and serverless function from Vercel stack.
It's simple, you can copy paste this markdown content, like this one:
There are several options you can use from the list:
| Options | Description | Type | Example | Query Params |
|---|---|---|---|---|
| [Theme] | Theme of the image | String |
default_repocard | ?theme=[value] |
| [Layout] | Layout of the image | String |
churchill | &layout=[value] |
| [Animation] | Animation of the image | String |
grow_out_in | &animation=[value] |
| [Background Color] | Background color of the image | Hex color code |
ffffff | &bgColor=[value] |
| [Opacity Pattern] | Opacity of the background pattern | Float number |
0 - 1 | &opacity=[value] |
| [Color Pattern] | Color of the background pattern | Hex color code |
1abc9c | &colorPattern=[value] |
| [Text Font Color] | Font color of the proverb text | Hex color code |
000000 | &textColor=[value] |
| [Category Font Color] | Font color of the category text | Hex color code |
000000 | &categoryColor=[value] |
| [Pattern] | Background pattern | String constant |
plus | &pattern=[value] |
| [Language] | Proverb language | String constant |
swahili | &language=[value] |
| [Width] | Image width | String |
100% | &width=[value] |
| [Height] | Image height | String |
100% | &height=[value] |
| [Keywords] | Proverb keywords | String/String Array |
love | &keywords=[value] |
Here is a list of supported image themes:
| Name | Value |
|---|---|
| Default | default |
| Default repocard | default_repocard |
| Dark | dark |
| Radical | radical |
| Merko | merko |
| Gruvbox | gruvbox |
| Tokyo night | tokyonight |
| One dark | onedark |
| Cobalt | cobalt |
| Synth wave | synthwave |
| High contrast | highcontrast |
| Dracula | dracula |
| Prussian | prussian |
| Monokai | monokai |
| Vue | vue |
| Vue dark | vue_dark |
| Shades of purple | shades_of_purple |
| Night owl | nightowl |
| Buefy | buefy |
| Blue green | blue_green |
| Algolia | algolia |
| Great Gatsby | great_gatsby |
| Darcula | darcula |
| Bear | bear |
| Solarized dark | solarized_dark |
| Solarized light | solarized_light |
| Chartreuse dark | chartreuse_dark |
| Nord | nord |
| Gotham | gotham |
| Material pale night | material_palenight |
| Gray white | graywhite |
| Vision friendly dark | vision_friendly_dark |
| Ayu mirage | ayu_mirage |
| Midnight purple | midnight_purple |
| Calm | calm |
| Flag India | flag_india |
| Omni | omni |
| React | react |
| Jolly | jolly |
| Maroongold | maroongold |
| Yeblu | yeblu |
| Sunny | sunny |
| Rainy | rainy |
| Blueberry | blueberry |
| State orange | slateorange |
| Kacho ga | kacho_ga |
| Arabesque | arabesque |
List of supported image layouts:
| Name | Value |
|---|---|
| Default | default |
| Churchill | churchill |
| Pluto | pluto |
| Samuel | samuel |
| Socrates | socrates |
| Zues | zues |
| Sophocles | sophocles |
| Hercules | hercules |
| Diogenes | diogenes |
| Herodote | herodote |
| Hermes | hermes |
| Pythagoras | pythagoras |
| Euclid | euclid |
| Ptolemy | ptolemy |
| Descartes | descartes |
| Erastosthenes | erastosthenes |
List of supported image animations:
| Name | Value |
|---|---|
| Default | default |
| Grow-out-in | grow_out_in |
List of languages supported by Proverb API:
| Name | Value |
|---|---|
| Afghan | afghan |
| African | african |
| Albanian | albanian |
| Algerian | algerian |
| American | american |
| Andorran | andorran |
| Angolan | angolan |
| Anii | anii |
| Antillean | antillean |
| Arabian | arabian |
| Argentinian | argentinian |
| Armenian | armenian |
| Ashanti | ashanti |
| Australian | australian |
| Austrian | austrian |
| Azerbaijani | azerbaijani |
| Babylonian | babylonian |
| Bahamian | bahamian |
| Bambara | bambara |
| Bantu | bantu |
| Basotho | basotho |
| Basque | basque |
| Bedouin | bedouin |
| Belgian | belgian |
| Belizean | belizean |
| Bengali | bengali |
| Beninese | beninese |
| Berber | berber |
| Bhutanese | bhutanese |
| Bible | bible |
| Bolivian | bolivian |
| Bosnian | bosnian |
| Botswana | botswana |
| Brazilian | brazilian |
| Breton | breton |
| Bugundan | bugundan |
| Bulgarian | bulgarian |
| Burkinabe | burkinabe |
| Burmese | burmese |
| Burundian | burundian |
| Byzantium | byzantium |
| Cambodian | cambodian |
| Cameroonian | cameroonian |
| Canadian | canadian |
| Canary Islands | canary_islander |
| Cape Verdean | cape_verdean |
| Catalan | catalan |
| Chadian | chadian |
| Chilean | chilean |
| Chinese | chinese |
| Colombian | colombian |
| Congolese | congolese |
| Corsican | corsican |
| Costa Rikan | costa_rikan |
| Creole | creole |
| Cretian | cretian |
| Croatian | croatian |
| Cuban | cuban |
| Cypriot | cypriot |
| Czech | czech |
| Czechoslovakian | czechoslovakian |
| Danish | danish |
| Darkovan | darkovan |
| Dominican | dominican |
| Dutch | dutch |
| Dwarven | dwarven |
| East African | east_african |
| East Asian | east_asian |
| Ecuadorian | ecuadorian |
| Egyptian | egyptian |
| English | english |
| Eritrean | eritrean |
| Eskimo | eskimo |
| Estonian | estonian |
| Ethiopian | ethiopian |
| Faroese | faroese |
| Fijian | fijian |
| Filipino | filipino |
| Finnish | finnish |
| Flemish | flemish |
| French Guianese | french_guianese |
| French | french |
| Gabonese | gabonese |
| Gaelic | gaelic |
| Gambian | gambian |
| Georgian | georgian |
| German | german |
| Ghanaian | ghanaian |
| Goan | goan |
| Greek | greek |
| Guadeloupe | guadeloupe |
| Guatemalan | guatemalan |
| Guinean | guinean |
| Guyanese | guyanese |
| Gypsy | gypsy |
| Haitian | haitian |
| Hasidic | hasidic |
| Hawaiian | hawaiian |
| Hebrew | hebrew |
| Hindu | hindu |
| Honduran | honduran |
| Hungarian | hungarian |
| Icelandic | icelandic |
| Indian | indian |
| Indonesian | indonesian |
| Iranian | iranian |
| Iraqi | iraqi |
| Irish | irish |
| Islamic | islamic |
| Israeli | israeli |
| Italian | italian |
| Ivorian | ivorian |
| Jamaican | jamaican |
| Japanese | japanese |
| Jewish | jewish |
| Jordanian | jordanian |
| Kanuri | kanuri |
| Kashmiri | kashmiri |
| Kenyan | kenyan |
| Kikuyu | kikuyu |
| Klingon | klingon |
| Koran | koran |
| Korean | korean |
| Kurdish | kurdish |
| Kyrgyzstani | kyrgyzstani |
| Laotian | laotian |
| Latin American | latin_american |
| Latin | latin |
| Latvian | latvian |
| Lebanese | lebanese |
| Lesotho | lesotho |
| Liberian | liberian |
| Libyan | libyan |
| Lithuanian | lithuanian |
| Luxembourgish | luxembourgish |
| Macedonian | macedonian |
| Malagasy | malagasy |
| Malawian | malawian |
| Malay | malay |
| Malaysian | malaysian |
| Malian | malian |
| Maltese | maltese |
| Maori | maori |
| Martiniquais | martiniquais |
| Massai | massai |
| Mauritanian | mauritanian |
| Mauritian | mauritian |
| Mexican | mexican |
| Mongolian | mongolian |
| Montenegro | montenegro |
| Moorish | moorish |
| Moroccan | moroccan |
| Mozambican | mozambican |
| Myanmar | myanmar |
| Namibian | namibian |
| Navajo | navajo |
| Nepalese | nepalese |
| New_zelander | new_zelander |
| Nicaraguan | nicaraguan |
| Nigerian | nigerian |
| Norwegian | norwegian |
| Omani | omani |
| Pakistani | pakistani |
| Somali | somali |
| Palestinian | palestinian |
| Panamanian | panamanian |
| Paraguayan | paraguayan |
| Persian | persian |
| Peruvian | peruvian |
| Philippine | philippine |
| Polish | polish |
| Portuguese | portuguese |
| Puerto Rikan | puerto_rikan |
| Romanian | romanian |
| Russian | russian |
| Rwandan | rwandan |
| Salvadorian | salvadorian |
| Samoan | samoan |
| Sanskrit | sanskrit |
| Sardinian | sardinian |
| Scottish | scottish |
| Senegalese | senegalese |
| Serbian | serbian |
| Sicilian | sicilian |
| Sierra Leonean | sierra_leonean |
| Singaporean | singaporean |
| Sinhalese | sinhalese |
| Slovakian | slovakian |
| Slovenian | slovenian |
| Solomon Islander | solomon_islander |
| South African | south_african |
| Spanish | spanish |
| Sri Lankan | sri_lankan |
| Sudanese | sudanese |
| Sumerian | sumerian |
| Surinamese | surinamese |
| Swahili | swahili |
| Swedish | swedish |
| Swiss | swiss |
| Syrian | syrian |
| Tahitian | tahitian |
| Taiwanese | taiwanese |
| Tajikistani | tajikistani |
| Talmud | talmud |
| Tamilan | tamilan |
| Tanzanian | tanzanian |
| Thai | thai |
| Tibetan | tibetan |
| Togolese | togolese |
| Tongan | tongan |
| Trinidadian | trinidadian |
| Tuareg | tuareg |
| Tunisian | tunisian |
| Turkish | turkish |
| Ugandan | ugandan |
| Uighur | uighur |
| Uruguayan | uruguayan |
| Venezuelan | venezuelan |
| Vermont | vermont |
| Vietnamese | vietnamese |
| Virgin Islander | virgin_islander |
| Walloon | walloon |
| Welsh | welsh |
| West African | west_african |
| Yemeni | yemeni |
| Yiddish | yiddish |
| Yugoslavian | yugoslavian |
| Zaire | zaire |
| Zambian | zambian |
| Zanzibar | zanzibar |
| Zen | zen |
| Zimbabwean | zimbabwean |
| Zulu | zulu |
Patterns in proverbs are provided by Hero Pattern package which is developed by Lowmess:
| Name | Value |
|---|---|
| Jigsaw | jigsaw |
| Overcast | overcast |
| Formal Invitation | formalInvitation |
| Topography | topography |
| Texture | texture |
| Jupiter | jupiter |
| Architect | architect |
| Cutout | cutout |
| Hideout | hideout |
| Graph Paper | graphPaper |
| Yyy | yyy |
| Squares | squares |
| Falling Triangles | fallingTriangles |
| Piano Man | pianoMan |
| Pie Factory | pieFactory |
| Dominos | dominos |
| Hexagons | hexagons |
| Charlie Brown | charlieBrown |
| Autumn | autumn |
| Temple | temple |
| Stamp Collection | stampCollection |
| Death Star | deathStar |
| Church on Sunday | churchOnSunday |
| I Like Food | iLikeFood |
| Overlapping Hexagons | overlappingHexagons |
| Four Point Stars | fourPointStars |
| Bamboo | bamboo |
| Bathroom Floor | bathroomFloor |
| CorkScrew | corkScrew |
| Happy Intersection | happyIntersection |
| Kiwi | kiwi |
| Lisbon | lisbon |
| Random Shapes | randomShapes |
| Steel Beams | steelBeams |
| Tiny Checkers | tinyCheckers |
| X Equals | xEquals |
| Anchors Away | anchorsAway |
| Bevel Circle | bevelCircle |
| Brick Wall | brickWall |
| Fancy Rectangles | fancyRectangles |
| Heavy Rain | heavyRain |
| Overlapping Circles | overlappingCircles |
| Plus | plus |
| Rounded Plus Connected | roundedPlusConnected |
| Volcano Lamp | volcanoLamp |
| Wiggle | wiggle |
| Bubbles | bubbles |
| Cage | cage |
| Connections | connections |
| Current | current |
| Diagonal Stripes | diagonalStripes |
| Flipped Diamonds | flippedDiamonds |
| Floating Cogs | floatingCogs |
| Glamorous | glamorous |
| Hounds tooth | houndstooth |
| Leaf | leaf |
| Lines In Motion | linesInMotion |
| Moroccan | moroccan |
| Morphing Diamonds | morphingDiamonds |
| Rails | rails |
| Rain | rain |
| Skulls | skulls |
| Squares In Squares | squaresInSquares |
| Stripes | stripes |
| Tic Tac Toe | ticTacToe |
| ZigZag | zigZag |
| Aztec | aztec |
| BankNote | bankNote |
| Boxes | boxes |
| Circles And Squares | circlesAndSquares |
| CircuitBoard | circuitBoard |
| Curtain | curtain |
| Diagonal Lines | diagonalLines |
| Endless Clouds | endlessClouds |
| Eyes | eyes |
| Floor Tile | floorTile |
| Groovy | groovy |
| Intersecting Circles | intersectingCircles |
| Melt | melt |
| Overlapping Diamonds | overlappingDiamonds |
| Parkay Floor | parkayFloor |
| Pixel Dots | pixelDots |
| Polka Dots | polkaDots |
| Signal | signal |
| Slanted Stars | slantedStars |
| Wallpaper | wallpaper |
These are examples of using Styled Proverbs:
Styled Proverbs is distributed under LGPL version 3 or later, [License]. LGPLv3 is additional permissions on top of GPLv3.
Styled Proverbs is maintained by the following GitHub team-members:
with community support please contact with us if you have some question or proposition.
The project uses SemVer for versioning. For the versions available, see the tags on this repository.
Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us (emoji key).
This project follows the all-contributors specification. Contributions of any kind are welcome!
See also the list of contributors who participated in this project.
https://lunrjs.com/guides/getting_started.html
Styled Proverbs Team would like inform that JetBrains is helping by provided IDE to develop the application. Thanks to its support program for an Open Source projects!
Styled Proverbs has experimental support for Gitpod, a pre-configured development environment that runs in your browser. To use Gitpod, click the button below and sign in with GitHub. Gitpod also offers a browser add-on, though it is not required.
Styled Proverbs project is using Lunr search tool to index and query text data by keywords.
Like Styled Proverbs ? Consider buying me a coffee :)
