@berqnet/fonts

@berqnet/fonts

Nuxt module for Font Installation.

Table of Contents

• Installation
• Usage
• Configuration
• Scripts
• Contributing
• License

Installation

To install this module, you can use npm or yarn:

npm

npm install @berqnet/fonts

yarn

yarn add @berqnet/fonts

Usage

To use this module in your Nuxt 3 project, add it to your nuxt.config.ts:

export default defineNuxtConfig({
  modules: ['@berqnet/fonts'],
});

Configuration

You can configure the module with the following options in your nuxt.config.ts: There are 2 type fonts exist currently: Poppins or Satoshi. Default font is Satoshi. You can change it manually using fontsOptions: { family: 'Poppins' } option or add option with module.

export default defineNuxtConfig({
  modules: [['@berqnet/fonts', { family: 'Poppins' }]],
  // Or add your custom configurations using fontsOptions attribute
  fontsOptions: { family: 'Poppins' },
});

Scripts

The following npm scripts are available:

• test: Run tests using Vitest.
• test:watch: Run tests in watch mode.
• test:types: Check TypeScript types.
• lint:prettier: Lint code using Prettier.
• lint:eslint: Lint code using ESLint.
• lint:stylelint: Lint styles using Stylelint.
• fix: Fix linting errors.
• pub: Publish the module.
• release: Release a new version.

Contributing

If you would like to contribute, please follow these guidelines:

1. Fork the repository.
2. Create a new branch for your feature or bug fix.
3. Commit your changes.
4. Push your branch and create a pull request.

License

This project is licensed under the MIT License.

_{Source for Poppins https://github.com/webfontworld/Poppins, Source for Satoshi https://www.fontshare.com/fonts/satoshi}