1.0.0 โ€ข Published 6 months ago

font-style-apis v1.0.0

Weekly downloads
-
License
ISC
Repository
github
Last release
6 months ago

Typing SVG

js dilvr

# Font Style API Example

This repository demonstrates how to use the `font-style-api` package to apply various text styles such as bold, bold-italic, flaky, and subfont to a given text string.

## Prerequisites

Before you begin, ensure that you have Node.js installed on your machine.

You can check if you have Node.js installed by running the following command in your terminal:

```bash
node -v

If you donโ€™t have it installed, you can download it from here.

Installation

  1. Clone the repository or create a new project folder.
  2. Run the following command to install the font-style-api package:
npm install font-style-apis

Usage

Create a new JavaScript file (e.g., index.js) and include the following code to apply different font styles to a string of text:

const { apply, bold, boldItalic, flaky, subfont } = require('font-style-apis');

const text = "Hello, World!";

// Apply bold style
const boldText = apply(text, bold);
console.log(boldText);

// Apply bold-italic style
const boldItalicText = apply(text, boldItalic);
console.log(boldItalicText);

// Apply flaky style
const flakyText = apply(text, flaky);
console.log(flakyText);

// Apply subfont style
const subfontText = apply(text, subfont);
console.log(subfontText);

Available Styles

  • bold: Applies a bold style to the text.
  • boldItalic: Applies both bold and italic styles to the text.
  • flaky: Applies a flaky, unstable style to the text.
  • subfont: Applies a subscript font style to the text.

Example Output

If you run the script, you will see the following output:

**Hello, World!**         // Bold text
***Hello, World!***       // Bold-italic text
โ›”H๐“ฎ๐—…๐—…๐—ˆ, ๐—ช๐—ˆ๐—‹๐—…๐—ฑ!โ›”      // Flaky text (simulated flaky style)
Hโ‚‚O                       // Subfont text (subscript applied)

License

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

Acknowledgements

  • Thanks to the creators of the font-style-api package for providing an easy-to-use solution for applying font styles programmatically.
This README provides a complete guide to setting up and using the script, with installation instructions, example usage, and a description of the available styles.
1.0.0

6 months ago