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

Jump to bottom

docs: update order of headings to be semantically correct #1335

Merged
merged 3 commits into from Sep 7, 2022
Merged

docs: update order of headings to be semantically correct #1335

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
98c7bbb
Update order of headings to be semantically correct
mnigh Sep 6, 2022
fc95249
Update order of headings to be semantically correct
mnigh Sep 6, 2022
aed746f
Merge branch 'main' into docs/fix-a11y
ST-DDT Sep 7, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/guide/migration-guide-v5.md
View file
Open in desktop
Expand Up @@ -2,7 +2,7 @@

[[toc]]
ST-DDT marked this conversation as resolved.
Show resolved Hide resolved

### ESM Support
## ESM Support

**New Format**: We're now ESM compatible! We've dropped the Browser bundle in favor of ESM.

Expand All @@ -16,7 +16,7 @@ So if you'd like to use `Faker` in the **browser**, simply include it using a [J
</script>
```

### Remove all references to `faker` from your project. The new package is located at `@faker-js/faker`
## Remove all references to `faker` from your project. The new package is located at `@faker-js/faker`

:::warning
You **MUST** swap all references from the `faker` package to the new `@faker-js/faker` package.
Expand All @@ -28,13 +28,13 @@ If you depend on a specific version of Faker you still can reference the version
`npm i @faker-js/faker@5.5.3 -D` will work just fine 😄.
:::

### TypeScript
## TypeScript

:::tip TypeScript Improvements
Faker now ships with its own types! Remove `@types/faker` from your `package.json` to avoid conflicts.
:::

### Tree-shaking
## Tree-shaking

:::warning
Tree shaking is not yet fully supported due to some structural issues. But we plan to make Faker fully tree-shakable in the future.
Expand Down
8 changes: 4 additions & 4 deletions docs/guide/migration-guide-v6.md
View file
Open in desktop
Expand Up @@ -2,11 +2,11 @@

[[toc]]

### Node 12 no longer supported
## Node 12 no longer supported

You need at least Node 14 to use Faker.

### Default export removed
## Default export removed

If you were previously importing faker like this:

Expand All @@ -20,7 +20,7 @@ You must instead use:
import { faker } from '@faker-js/faker';
```

### Deprecated methods changed
## Deprecated methods changed

Several methods were renamed or moved:

Expand All @@ -39,7 +39,7 @@ Several methods were renamed or moved:
| faker.datatype.hexaDecimal | faker.datatype.hexadecimal |
| faker.name.title | faker.name.jobTitle |

### Deprecated methods removed
## Deprecated methods removed

Some methods were removed without a direct alternative. If you are using any of these methods you should build an object containing the specific properties you need.

Expand Down