https://github.com/codewhiteweb/github-readme-riddle
GitHub Readme Riddles : Display Random riddles 🤔 on your github profile 🤓
https://github.com/codewhiteweb/github-readme-riddle
github github-readme profile-readme profile-readme-generator readme serverless
Last synced: 9 months ago
JSON representation
GitHub Readme Riddles : Display Random riddles 🤔 on your github profile 🤓
- Host: GitHub
- URL: https://github.com/codewhiteweb/github-readme-riddle
- Owner: CodeWhiteWeb
- License: mit
- Created: 2022-07-08T04:54:40.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2022-07-08T06:19:53.000Z (over 3 years ago)
- Last Synced: 2025-03-30T08:07:15.161Z (10 months ago)
- Topics: github, github-readme, profile-readme, profile-readme-generator, readme, serverless
- Language: JavaScript
- Homepage: https://github-readme-riddle.vercel.app/api
- Size: 48.8 KB
- Stars: 7
- Watchers: 1
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Github Readme Riddle
Everyday Riddles for your Github Readme.
Test your brain everday 😉
## Features ✨
- [Dynamic riddle in your GitHub Readme.](#Demo)
- [Create your own riddle.](#Custom)
## Usage ⚡️
Copy the markdown below and paste it in your Github Readme.
```md
[](https://github.com/CodeWhiteWeb/github-readme-riddle)
```
### Options
| Options | Default | Available |
| ------- | -------- | --------------------------------|
| type | vertical | horizontal, vertical |
| theme | light | check out [Theme.md](./theme.md)|
## Installation and Development 🚀
To get started with developing this app locally, here are the steps:
Install the dependencies for the app using,
```sh
npm install
# or
yarn
```
And, then run the app using,
```sh
npx vercel dev
# or
yarn run vercel dev
```
## Demo
### Vertical
> You don't need to add **?type=vertical** parameter.
[](https://github.com/CodeWhiteWeb/github-readme-riddle)
### Horizontal
> You need to add **?type=horizontal** parameter.
[](https://github.com/CodeWhiteWeb/github-readme-riddle)
### Light
> You don't need to add **?theme=light** parameter.
[](https://github.com/CodeWhiteWeb/github-readme-riddle)
### Dark
> You need to add **?theme=dark** parameter.
[](https://github.com/CodeWhiteWeb/github-readme-riddle)
### Other themes
> You need to add **?theme={theme_name}** parameter.
> Check out [Theme.md](./theme.md) for all themes (50+ themes)
## Contributing 🤝
Contributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/CodeWhiteWeb/github-readme-riddle/issues).
## Special Thanks ❤
- Inspired from [AnuragHazra/github-readme-stats](https://github.com/anuraghazra/github-readme-stats) & [PiyushSuthar/github-readme-quotes](https://github.com/PiyushSuthar/github-readme-quotes).
- [nkilm/riddles-api](https://github.com/nkilm/riddles-api) for Riddle API.
## Show your support 🌈
Be sure to drop a 🌟 if you like the project!
## Author 🤗
👤 **CodeWhiteWeb**
- Website: https://CodeWhiteWeb.cf
- Twitter: [@CodeWhiteWeb1](https://twitter.com/CodeWhiteWeb1)
- Github: [@CodeWhiteWeb](https://github.com/CodeWhiteWeb)
Made by CodeWhiteWeb with ❤ and JavaScript.