font-style-api
v1.1.0
Published
A simple font transformation utility for bold text
Downloads
662
Readme
# 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
- Clone the repository or create a new project folder.
- Run the following command to install the
font-style-api
package:
npm install font-style-api
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-api');
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.