Function variableReadme

packages/cli/src/templates/readme.ts:58–114

({
	id,
	family,
	version,
	weights,
	styles,
	subsets,
	variable,
	license,
}: Metadata)

If you have any suggestions or ideas to improve the performance of font loading or expand the existing library, feel free to star and contribute to this repository. You can share your suggestions or ideas by creating an [issue](https://github.com/fontsource/fontsource/issues).`;

const variableReadme = ({
	id,
	family,
	version,
	weights,
	styles,
	subsets,
	variable,
	license,
}: Metadata) => `# Fontsource ${family}

[![npm (scoped)](https://img.shields.io/npm/v/@fontsource-variable/${id}?color=brightgreen)](https://www.npmjs.com/package/@fontsource-variable/${id}) [![Generic badge](https://img.shields.io/badge/fontsource-passing-brightgreen)](https://github.com/fontsource/fontsource) [![Monthly downloads](https://badgen.net/npm/dm/@fontsource-variable/${id})](https://github.com/fontsource/fontsource) [![Total downloads](https://badgen.net/npm/dt/@fontsource-variable/${id})](https://github.com/fontsource/fontsource) [![GitHub stars](https://img.shields.io/github/stars/fontsource/fontsource.svg?style=social&label=Star)](https://github.com/fontsource/fontsource/stargazers)

The CSS and web font files to easily self-host the “${family}” variable font. Please visit the main [Fontsource website](https://fontsource.org/fonts/${id}) to view more details on this package.

## Quick Installation

Fontsource offers multiple methods to import the CSS, including using a bundler like Vite or using SASS. You can find full documentation [here](https://fontsource.org/docs/getting-started/introduction).

\`\`\`javascript
npm install @fontsource-variable/${id}
\`\`\`

Within your app entry file or site component, import it in.

\`\`\`javascript
import "@fontsource-variable/${id}"; // Defaults to wght axis
import "@fontsource-variable/${id}/wght.css"; // Specify axis
import "@fontsource-variable/${id}/wght-italic.css"; // Specify axis and style
\`\`\`

Supported variables:
- Weights: \`[${String(weights)}]\`
- Styles: \`[${String(styles)}]\`
- Subsets: \`[${String(subsets)}]\`
- Axes: \`[${String(Object.keys(variable).filter((axis) => axis !== 'ital'))}]\`

> Note: \`italic\` may not be supported by all fonts. To learn more about what axes and styles are supported, please visit the [Fontsource website](https://fontsource.org/fonts/${id}).

Finally, you can reference the font name in a CSS stylesheet, CSS Module, or CSS-in-JS.

\`\`\`css
body {
  font-family: "${family} Variable";
}
\`\`\`

## Licensing
Always make sure to read the license for each font you use. Most of the fonts in the collection use the SIL Open Font License, v1.1. Some fonts use the Apache 2 license. The Ubuntu fonts use the Ubuntu Font License v1.0.

${license.attribution}
[${license.type}](${license.url})

## Other Notes
Font version (provided by source): \`${version}\`.

If you have any suggestions or ideas to improve the performance of font loading or expand the existing library, feel free to star and contribute to this repository. You can share your suggestions or ideas by creating an [issue](https://github.com/fontsource/fontsource/issues).`;