PhpDev.App
DenverCoder1/readme-typing-svg

DenverCoder1/readme-typing-svg

Stars: 3499

Forks: 555

Pull Requests: 189

Issues: 50

Watchers: 19

Last Updated: 2023-09-15 16:54:09

#dynamic #readme #profile-readme #svg #serverless #animation #github #typing #hacktoberfest #php

⚡ Dynamically generated, customizable SVG that gives the appearance of typing and deleting text for use on your profile page, repositories, or website.

License: MIT License

Languages: PHP, CSS, JavaScript, Procfile

https://readme-typing-svg.demolab.com

⌨️ Readme Typing SVG

Example Usage - README Typing SVG

⚡ Quick setup

  1. Copy-paste the markdown below into your GitHub profile README
  2. Replace the value after ?lines= with your text. Separate lines of text with semicolons and use + or %20 for spaces.
  3. Adjust the width parameter (see below) to fit the full width of your text.
[![Typing SVG](https://readme-typing-svg.demolab.com/?lines=First+line+of+text;Second+line+of+text)](https://git.io/typing-svg)
  1. Star the repo 😄

⚙ Demo site

Here you can easily customize your Typing SVG with a live preview.

https://readme-typing-svg.demolab.com/demo/

Demo Site

🚀 Example usage

Below are links to profiles where you can see Readme Typing SVGs in action!

Jonah Lawrence Jini by Rentalz.com Waren Gonzaga Eke Victor 8BitJonny Aditya Raute Shiva Sankeerth Reddy Tarun Kamboj T.A.Vignesh Angelo Fallaria William J. Ghelfi Mano Bharathi M Shivam Yadav Pratik Pingale Vydr'Oz Caroline Heloíse PriyanshK09 BenjaminMichaelis Thakur Ballary NiceSapien Manthan Ank Ronny Coste Vishal Beep Raihan Khan wiz64 Aquarian Blake D3vil0p3r EliusHHimel jcs090218 Rishabh2804 shalinibhatt UlisesAlexanderAM SpookyJelly yousafesaeed cfcife majidtdeni666 GalexY727 HectorSaldes Ash-codes18 Maagnitude cracker911181 quiet-node ProfCyberNaught kaustubh43 kaisunoo meyer-pidiache jeremiahseun Purushottam Anand Greg Chism turbomaster95 K1rsN7 codesbyahsen Freddywhest Shiro-cha Abid-Nafi Srijan-Baniyal BrunoOliveiraS zidk tshr

Feel free to open a PR and add yours!

🔧 Options

Parameter Details Type Example
lines Text to display with lines separated by ; and + for spaces string First+line;Second+line;Third+line
height Height of the output SVG in pixels (default: 50) integer Any positive number
width Width of the output SVG in pixels (default: 400) integer Any positive number
size Font size in pixels (default: 20) integer Any positive number
font Font family (default: monospace) string Any font from Google Fonts
color Color of the text (default: 36BCF7) string Hex code without # (eg. F724A9)
background Background color of the text (default: 00000000) string Hex code without # (eg. FEFF4C)
center true to center text or false for left aligned (default: false) boolean true or false
vCenter true to center vertically or false(default) to align above the center boolean true or false
multiline true to wrap lines or false to retype on one line (default: false) boolean true or false
duration Duration of the printing of a single line in milliseconds (default: 5000) integer Any positive number
pause Duration of the pause between lines in milliseconds (default: 0) integer Any non-negative number
repeat true to loop around to the first line after the last (default: true) boolean true or false
separator Separator used between lines in the lines parameter (default: ;) string ;, ;;, /, etc.

📤 Deploying it on your own

If you can, it is preferable to host the files on your own server.

Doing this can lead to better uptime and more control over customization (you can modify the code for your usage).

You can deploy the PHP files on any website server with PHP installed or as a Heroku app.

Step-by-step instructions for deploying to Heroku

  1. Sign in to Heroku or create a new account at https://heroku.com
  2. Click the "Deploy to Heroku" button below

Deploy

  1. On the page that comes up, click "Deploy App" at the end of the form
  2. Once the app is deployed, click "Manage App" to go to the dashboard
  3. Scroll down to the Domains section in the settings to find the URL you will use in place of readme-typing-svg.demolab.com

🤗 Contributing

Contributions are welcome! Feel free to open an issue or submit a pull request if you have a way to improve this project.

Make sure your request is meaningful and you have tested the app locally before submitting a pull request.

Refer to CONTRIBUTING.md for more details on contributing, installing requirements, and running the application.

🙋‍♂️ Support

💙 If you like this project, give it a ⭐ and share it with friends!

Youtube Sponsor with Github

☕ Buy me a coffee

Made with ❤️ and PHP

Powered by Heroku

This project uses Twemoji, published under the CC-BY 4.0 License

OPEN ISSUES

See all

RELEASES

See all