feat: adding documentation with vitepress (#80)

1 files changed, 11 insertions, 0 deletions

diff --git a/docs/api/fake.md b/docs/api/fake.md
new file mode 100644
index 00000000..8fae509a
--- /dev/null
+++ b/docs/api/fake.md
@@ -0,0 +1,11 @@
+# Fake
+
+Useful generator method `faker.fake()` for combining faker API methods using a mustache string format.
+
+```js
+faker.fake('{{name.lastName}}, {{name.firstName}} {{name.suffix}}');
+// Wintheiser, Shaylee Sr.
+
+faker.fake('{{company.bs}} is short for {{address.streetName}}');
+// cutting-edge leverage web services is short for Flatley Rue
+```