4

GitHub - DenverCoder1/readme-typing-svg: ⚡ Dynamically generated, customizable S...

 3 years ago
source link: https://github.com/DenverCoder1/readme-typing-svg
Go to the source link to view the article. You can view the picture content, updated content and better typesetting reading experience. If the link is broken, please click the button below to view the snapshot at that time.
neoserver,ios ssh client

keyboard Readme Typing SVG

zap 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. (Optional) Adjust the width parameter (see below) to fit the full width of your text.
[![Typing SVG](https://readme-typing-svg.herokuapp.com/?lines=First+line+of+text;Second+line+of+text)](https://git.io/typing-svg)

gear Demo site

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

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

rocket Example usage

Feel free to open a PR and add yours!

wrench Options

Parameter Details Type Example lines Text to display with lines separated by ; and + for spaces string First+line;Second+line;Third+line 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 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 font Font family (default: monospace) string Any font from Google Fonts size Font size in pixels (default: 20) integer Any positive number color Color of the text (default: 36BCF7) string Hex code without # (eg. 00ff00) multiline true to wrap lines or false to retype on one line (default: false) boolean true or false

outbox_tray 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
  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.herokuapp.com

hugs 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.

Installing requirements

Requirements

Linux

sudo apt-get install php
sudo apt-get install php-curl
sudo apt-get install composer

Windows

Install PHP from XAMPP or php.net

Clone the repository

git clone https://github.com/DenverCoder1/readme-typing-svg.git
cd readme-typing-svg

Running the app locally

composer start

Open http://localhost:8000/ and add parameters to run the project locally.

Running the tests

Before you can run tests, PHPUnit must be installed. You can install it using Composer by running the following command.

composer install

Run the following command to run the PHPUnit test script which will verify that the tested functionality is still working.

composer test

raising_hand_man Support

blue_heart If you like this project, give it a star and share it with friends!

Made with heart and PHP


report

Recommend

About Joyk


Aggregate valuable and interesting links.
Joyk means Joy of geeK