@nfq/next-fonts
Version:
Next.js plugin to load and preload fonts
81 lines (51 loc) • 2.31 kB
Markdown
<div id="top"></div>
# @NFQ Next.Js Fonts
[](https://opensource.org/license/mit/)
[](https://github.com/nfqde/nfq-next-fonts/actions/workflows/eslint.yml)
[](https://github.com/nfqde/nfq-next-fonts/actions/workflows/horusec.yml)
[](https://github.com/nfqde/nfq-next-fonts/actions/workflows/cypress.yml)
1. [Description](#description)
2. [Getting started](#getting-started)
1. [Installation](#installation)
2. [PeerDependencies](#peerdependencies)
3. [Usage](#usage)
4. [Props](#props)
5. [Support](#support)
## Description: [](https://opensource.org/licenses/MIT)
An small package that adds auto @font-face generation to your next.js project. It also adds the preview link tags to the head of the document.
<p align="right">(<a href="#top">back to top</a>)</p>
## Getting started
To setup the project locally follow the next steps:
### Installation
To install the package run
```sh
npm install <Project name>
```
if you are on yarn
```sh
yarn add <Project name>
```
or on pnpm
```sh
pnpm install <Project name>
```
### PeerDependencies:
The following PeerDependencies are needed so the package does work:
- typescript >= 4.9.5
<p align="right">(<a href="#top">back to top</a>)</p>
## Usage
Use this space to show useful examples of how a project can be used. Additional screenshots, code examples and demos work well in this space. You may also link to more resources.
_For more examples, please refer to the [Documentation](https://example.com)_
<p align="right">(<a href="#top">back to top</a>)</p>
## Props
Use this space for prop tables if you make an react module or for params if you create js module. Or use it for arguments if you create an cli.
<p align="right">(<a href="#top">back to top</a>)</p>
## Support
Christoph Kruppe - [https://github.com/ckruppe] - c.kruppe@nfq.de
<p align="right">(<a href="#top">back to top</a>)</p>