Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(readme): remove troubleshooting #9

Merged
merged 1 commit into from
Mar 23, 2024
Merged

docs(readme): remove troubleshooting #9

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 2 additions & 25 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,6 @@

- [Naming Convention](#naming-convention)

- [Troubleshooting](#troubleshooting)

- [Contributing](#contributing)

- [License](#license)
Expand Down Expand Up @@ -87,10 +85,10 @@ const validFontFileName = 'OpenSans-regular';
const invalidFontFileName = 'OpenSans.woff2';

// returns: true
console.log(await validateFontFileName(validFontFileName));
console.log(await validateFontFileName(validFontFileName, yourPattern));

// returns: 'OpenSans.woff2' doesn't match with '/OpenSans-regular/'.
console.log(await validateFontFileName(invalidFontFileName));
console.log(await validateFontFileName(invalidFontFileName, yourPattern));
```

## Naming Convention
Expand All @@ -102,27 +100,6 @@ Extensions that are allowed: `otf`, `ttf`, `woff`, `woff2`.

> `{FontFamily}-{FontWeight}.{ext}`

## Troubleshooting

> \[!WARNING]
> Developers Only.

If you are using **npm**, you may get a `peerDependency` error
that is related to these plugins:

- `typescript-eslint/eslint-plugin`.
- `typescript-eslint/parser`.

To fix this you can switch to **pnpm**(recommended) or install version `6.0.0`:

```shell
typescript-eslint/eslint-plugin@6.0.0
```

```shell
typescript-eslint/parser@6.0.0
```

## Contributing

Please read [**CONTRIBUTING**](https://github.com/archoleat/.github/blob/main/CONTRIBUTING.md)
Expand Down
Loading