feat: adding documentation with vitepress (#80)

1 files changed, 67 insertions, 0 deletions

diff --git a/docs/api/localization.md b/docs/api/localization.md
new file mode 100644
index 00000000..dbd03b43
--- /dev/null
+++ b/docs/api/localization.md
@@ -0,0 +1,67 @@
+# Localization
+
+As of version `v2.0.0` Faker has support for multiple localities.
+
+The default language locale is set to English.
+
+Setting a new locale is simple:
+
+```js
+// sets locale to de
+faker.setLocale('de');
+// or
+faker.locale = 'de';
+```
+
+- az
+- cz
+- de
+- de_AT
+- de_CH
+- en
+- en_AU
+- en_BORK
+- en_CA
+- en_GB
+- en_IE
+- en_IND
+- en_US
+- en_ZA
+- en_au_ocker
+- es
+- es_MX
+- fa
+- fr
+- fr_CA
+- ge
+- id_ID
+- it
+- ja
+- ko
+- nb_NO
+- nep
+- nl
+- pl
+- pt_BR
+- pt_PT
+- ru
+- sk
+- sv
+- tr
+- uk
+- vi
+- zh_CN
+- zh_TW
+
+## Individual Localization Packages
+
+As of version `v3.0.0` Faker supports incremental loading of locales.
+
+By default, requiring `faker` will include _all_ locale data.
+
+In a production environment, you may only want to include the locale data for a specific set of locales.
+
+```js
+// loads only de locale
+const faker = require('faker/locale/de');
+```