docs: document new ogImage support (#40)

nuxt-community · Mar 8, 2018 · 6481d2b · 6481d2b
1 parent 841640a
commit 6481d2b
Showing 1 changed file with 18 additions and 0 deletions.
diff --git a/docs/modules/meta.md b/docs/modules/meta.md
@@ -71,6 +71,24 @@ Please read this resources before you enable `mobileAppIOS` option:
 - Default: same as options.description
 - Meta: `og:description`
 
+**ogHost**
+Specify the domain that the site is hosted. Required for ogImage.
+- Default: `undefined`
+- Meta: `N/A`
+
+**ogImage**
+- Default: `true`
+- Meta: `og:image` and sub-tags
+
+These types are accepted:
+
+- Boolean: the icons from the `icon` module are used.
+- String: the path is used.
+- Object:
+  * `path`: specify the path.
+  * `width`, `height`: specify the dimensions, respectively.
+  * `type`: specify the MIME type.
+
 **nativeUI**
 - Default: `false`