aboutsummaryrefslogtreecommitdiff
path: root/docs/guide
diff options
context:
space:
mode:
authorShinigami <[email protected]>2023-04-03 17:55:56 +0200
committerGitHub <[email protected]>2023-04-03 15:55:56 +0000
commitfc2f171670b05019e0582d7c1b6b34c24c1d15f1 (patch)
tree9101b290b4798c4a3b5bbb585091ac70c3d03099 /docs/guide
parentde078de89bf1b52de153f88352cf534811673886 (diff)
downloadfaker-fc2f171670b05019e0582d7c1b6b34c24c1d15f1.tar.xz
faker-fc2f171670b05019e0582d7c1b6b34c24c1d15f1.zip
docs: normalize blocks (#2002)
Diffstat (limited to 'docs/guide')
-rw-r--r--docs/guide/localization.md4
-rw-r--r--docs/guide/upgrading.md5
-rw-r--r--docs/guide/usage.md6
3 files changed, 7 insertions, 8 deletions
diff --git a/docs/guide/localization.md b/docs/guide/localization.md
index 0271fe1c..ba62aeb8 100644
--- a/docs/guide/localization.md
+++ b/docs/guide/localization.md
@@ -10,7 +10,7 @@ However, we also provide pre-built instances for more than 50 other locales.
See below for a list of available locales.
-:::tip Note
+::: tip Note
You can also build your own Faker instances, with custom locales/overwrites.
:::
@@ -33,7 +33,7 @@ The English locales are around 600 KB in size.
All locales together are around 5 MB in size.
:::
-:::tip Note
+::: tip Note
Some locales have limited coverage and rely more heavily on the English locale as the source for features they currently do not have.
However, in most cases, using a specific locale will be beneficial in the long term as specifying a locale reduces the time necessary for startup, which has a compounding effect on testing frameworks that reload the imports every execution.
:::
diff --git a/docs/guide/upgrading.md b/docs/guide/upgrading.md
index 1987ed0e..38b3dc65 100644
--- a/docs/guide/upgrading.md
+++ b/docs/guide/upgrading.md
@@ -4,8 +4,7 @@ This is the migration guide for upgrading from v7 to v8.
Since v8 has not yet been released, this is a work in progress list of any major and breaking changes in v8.
-::: info
-Not the version you are looking for?
+::: info Not the version you are looking for?
- [Upgrading to v7](https://v7.fakerjs.dev/guide/upgrading.html)
- [Upgrading to v6](https://v6.fakerjs.dev/migration-guide-v5/)
@@ -16,7 +15,7 @@ Not the version you are looking for?
### Removed ability to change the locale on existing `Faker` instances
-:::tip NOTE
+::: tip Note
If you are using only the default (`en`) locale, then you don't have to change anything.
:::
diff --git a/docs/guide/usage.md b/docs/guide/usage.md
index 26f81c08..f97590af 100644
--- a/docs/guide/usage.md
+++ b/docs/guide/usage.md
@@ -37,7 +37,7 @@ For more information about changing and customizing the locales, please refer to
</script>
```
-::: info NOTE
+::: info Note
Using the browser is great for experimenting 👍. However, due to all of the strings Faker uses to generate fake data, **Faker is a large package**. It's `> 5 MiB` minified. **Please avoid deploying the full Faker in your web app.**
:::
@@ -50,7 +50,7 @@ const randomName = faker.person.fullName(); // Willie Bahringer
const randomEmail = faker.internet.email(); // [email protected]
```
-::: info NOTE
+::: info Note
It is highly recommended to use version tags when importing libraries in Deno, e.g: `import { faker } from "https://cdn.skypack.dev/@faker-js/[email protected]"`. Add `?dts` to import with type definitions: `import { faker } from "https://cdn.skypack.dev/@faker-js/[email protected]?dts"`.
:::
@@ -104,7 +104,7 @@ const secondRandom = faker.number.int();
console.log(firstRandom === secondRandom);
```
-::: info NOTE
+::: info Note
When upgrading to a new version of Faker, you may get different values for the same seed, as the underlying data (lists of names, words etc) may have changed.
:::