astro-fontaine's Introduction

astro-fontaine

This is an Astro plugin that will automatically generate fallback fonts for the web fonts in your site to prevent CLS using the wonderful fontaine library.

It does the following:

Downloads provided font stylesheets.
Parses and extracts all @font-face definitions.
Downloads the fonts to your site's public directory and rewrites the stylesheet to use the fonts hosted on your site's domain.
Generates fallback fonts.
Inlines the rewritten font stylesheets and fallback @font-face declarations into all pages in your site's build.

Usage

Add this code to your astro.config.js:

import { defineConfig } from 'astro/config'
import fontaine from 'astro-fontaine'

export default defineConfig({
  integrations: [
    fontaine({
      // If you are using Google Fonts, Typekit or some other font hosting service, you can provide the URL to the
      // stylesheet here and the plugin will download and inline it into your webpages automatically.
      remoteFontFaceStylesheetURLs: [
        'https://fonts.googleapis.com/css2?family=Arvo:ital,wght@0,400;0,700;1,400;1,700&family=Fira+Code&family=Lato:ital,wght@0,400;0,700;0,900;1,400;1,700;1,900&display=fallback',
      ],
      // Array of font families that will be used to generate the fallback fonts
      fonts: [
        {
          family: 'Arvo',
          // You can provide fallbacks per fronts such that the fallback font is of the same style when it flashes.
          fallbacks: ['Georgia', 'Cambria'],
        },
        // If you omit fallbacks, the defaultFallbacks property will be used.
        { family: 'Lato' },
        {
          family: 'Fira Code',
          fallbacks: [
            'SFMono-Regular',
            'Menlo',
            'Monaco',
            'Consolas',
            'Liberation Mono',
            'Courier New',
            'monospace',
          ],
        },
      ],
      defaultFallbacks: [
        'ui-sans-serif',
        'Helvetica Neue',
        'Arial',
        'sans-serif',
      ],
    }),
  ]
})