npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

readme-typing-svg-ts

v0.1.2

Published

[![NPM Version](https://img.shields.io/npm/v/readme-typing-svg-ts)](https://www.npmjs.com/package/readme-typing-svg-ts) [![Build Status](https://github.com/liudonghua123/readme-typing-svg-ts/actions/workflows/ci.yml/badge.svg)](https://github.com/liudong

Downloads

3

Readme

readme-typing-svg-ts

NPM Version Build Status License

readme-typing-svg-ts is a TypeScript library that generates typing SVG animations for your GitHub README files. Enhance your README with dynamic, typewriter-style text effects to capture attention and convey information more effectively.

Features

  • Typing Animation: Generate SVG animations that simulate typing.
  • Customizable: Adjust text, typing speed, colors, and more.
  • TypeScript: Benefit from type safety and modern JavaScript features.
  • Lightweight: Minimal dependencies for a lightweight footprint.
  • Easy Integration: Simple to integrate into any GitHub README.

Installation

Install the package via npm:

npm install readme-typing-svg-ts

Or via yarn:

yarn add readme-typing-svg-ts

Usage

LIB usage

Import the library and generate a typing SVG:

import { createTypingSVG } from "readme-typing-svg-ts";

const svg = createTypingSVG({
  text: ["Hello", "world!"],
});

console.log(svg);

process.exit(0);

CLI usage

Install the package globally:

npm install -g readme-typing-svg-ts # or yarn global add readme-typing-svg-ts
> readme-typing-svg-ts --help
Usage: cli [options]

Options:
  -t, --text <items>             Text to type (default: "Hello, World!")
  -s, --size <number>            Font size (default: "20")
  -m, --font <string>            Font family (default: "Fira Code")
  -l, --letter-spacing <string>  Letter spacing (default: "normal")
  -c, --color <color>            Text color (default: "#36BCF7")
  -b, --background <color>       Background color (default: "#00000000")
  --width <number>               SVG width (default: "400")
  --height <number>              SVG height (default: "50")
  --pause <number>               Pause between texts in ms (default: "1000")
  --duration <number>            Duration per line in ms (default: "5000")
  --center                       Horizontally center text (default: false)
  --vCenter                      Vertically center text (default: false)
  --multiline                    Each sentence on a new line (default: false)
  --repeat                       Repeat text (default: true)
  -o, --output <path>            Output path (default: "typing.svg")
  -h, --help                     display help for command

> readme-typing-svg-ts -t "hello,world"
SVG file created at D:\code\node\readme-typing-svg-ts\examples\typing.svg

> 

Parameters

See the full available config options on src/lib.ts.

Examples

See the examples/simple_demo.ts directory for sample usage.

Development

To contribute or modify the library, clone the repository and install the dependencies:

git clone https://github.com/liudonghua123/readme-typing-svg-ts.git
cd readme-typing-svg-ts
npm install

Run the development server:

npm run build # build the static files served via gh-pages
npm run build-lib # build the lib and cli

Run tests:

npm test

License

This project is licensed under the MIT License. See the LICENSE file for details.

Contributing

Contributions are welcome! Please see the CONTRIBUTING.md file for guidelines.

Acknowledgements

Special thanks to the contributors and the open-source community for their support.