Skip to content

Commit

Permalink
docs: normalize blocks (#2002)
Browse files Browse the repository at this point in the history
  • Loading branch information
Shinigami92 authored Apr 3, 2023
1 parent de078de commit fc2f171
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/about/announcements/2022-01-14.md
Original file line number Diff line number Diff line change
Expand Up @@ -107,7 +107,7 @@ We were closing issues every other hour. Discussing the `FUNDING.yml` was inevit

When we became aware that this project was the most stable fork of Faker with the most community support, we realized that we needed to deal with the `FUNDING.yml` file and take a stance.

:::tip Short version, please
::: tip Short version, please
Jess posted a [concise and thorough writeup](https://github.com/faker-js/faker/discussions/56#discussioncomment-1958057) of the logic behind our actions and decisions.

This was backed by the support of all of the co-maintainers. It's a much less narrative version of this section, so if you want the TLDR and some photos of the transactions, give it a read.
Expand All @@ -123,7 +123,7 @@ Ben said that simply, "The funding is attached to the project, not the current m

Unanimously, we agreed that we **wanted absolutely no ability to touch the existing funding** and created a cut-over plan with the support of Open Collective.

:::tip Legacy collective
::: tip Legacy collective
There is now a [fakerjs-legacy](https://opencollective.com/fakerjs-legacy) collective. Open Collective transferred all funds into the legacy account and invited Marak and the other maintainer, Brian, into the _legacy_ collective so that they could do whatever they wanted with the funds.
:::

Expand Down
4 changes: 2 additions & 2 deletions docs/guide/localization.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
:::

Expand All @@ -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.
:::
Expand Down
5 changes: 2 additions & 3 deletions docs/guide/upgrading.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/)
Expand All @@ -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.
:::

Expand Down
6 changes: 3 additions & 3 deletions docs/guide/usage.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.**
:::

Expand All @@ -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"`.
:::

Expand Down Expand Up @@ -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.
:::

Expand Down

0 comments on commit fc2f171

Please sign in to comment.