@frontlabs/google-fonts-downloader v1.0.15

@frontlabs/google-fonts-downloader

Description

@frontlabs/google-fonts-downloader is a lightweight and efficient package designed to simplify the process of self-hosting Google Fonts. By leveraging this package, developers can effortlessly download Google Fonts to their local environment, enabling seamless integration and improved website performance.

Motivation

While working on improving PageSpeed, I discovered the significant enhancements brought by Google Fonts v2. Everything seemed to become smoother and lighter, from font sizes to the ability to reuse various font weights. Despite my efforts to find a suitable API or package for immediate use, I came up empty-handed.

For instance, take the font Inter. The font sizes of version 1 compared to version 2 were 100kb and 10kb respectively. Different font weights could be utilized within a single file. The savings were substantial, sparking a strong inspiration within me to create this package. It's evident that this project has the potential to make a substantial impact on metrics such as FCP, LCP, and overall PageSpeed scores, significantly benefiting your website.

This project aims to harness the efficiencies of Google Fonts v2, offering a streamlined solution for integrating fonts into web projects. By optimizing font usage, we can enhance website performance and user experience, ultimately leading to improved rankings and user engagement.

Features

• Effortless Font Download: Quickly fetch and download Google Fonts to your local project directory with minimal configuration.

• Customizable Options: Customize font selection, variants, and subsets to tailor the download to your specific project needs.

• Optimized Performance: Reduce page load times and enhance website performance by serving fonts directly from your server.

• Automatic Updates: Keep your local fonts up-to-date with automatic updates to ensure compatibility and security.

Installation

npm install @frontlabs/google-fonts-downloader

Usage

import { createDownloadGoogleFont } from '@frontlabs/google-fonts-downloader'
const helper = createDownloadGoogleFont({
  base: 'https://test.com',
  metadata: {
    name: 'metadata.json',
    override: false,
    outputPath: path.resolve('.output/metadata'),
  },
  outputPath: path.resolve('.output'),
  css: {
    write: true,
    combie: true,
  },
  font: {
    outputPath: path.resolve('.output/fonts'),
  },
})

// Download a font
helper.download('Inter')
helper.download('Inter', { weight: [400] })

// Download all fonts
helper.downloadAll()

Contributing

Contributions are welcome! If you find any issues or have suggestions for improvements, please open an issue or submit a pull request.

License

This project is licensed under the MIT License.