Contributing

We can never thank you enough for your contributions.
It is highly recommended to read the Nuxt contribution guide before making any contributions.

How to contribute?

  • Clone nuxt/fonts repository
  • Enable Corepack using corepack enable
  • Install dependencies using pnpm install
  • Run pnpm dev:prepare to generate type stubs.
  • Use pnpm dev to start the playground in development mode.
  • Apply your changes
  • Add tests into the test/ directory and run pnpm test to make sure they pass.
  • Check the code style with pnpm lint
  • Before creating a PR, make sure to run pnpm build and that no errors are reported.

Documentation

  • Use pnpm docs:dev to start the documentation in development mode.
  • Open http://localhost:3000 to view it in the browser.
  • Update the content of the documentation in the docs/content/ directory.

Advanced

Find out how Nuxt Fonts works behind the scenes to optimize fonts in your project.