Add renderer docs

Author: janniks

docs/README.md

@@ -2,7 +2,69 @@
 
 ## vue-notion `NotionRenderer`
 
-_coming soon..._
+The `NotionRenderer` component offers a few properties
+
+- [`blockMap`](#blockMap) – required
+- [`contentId`](#contentId) – default: `undefined`
+- [`fullPage`](#fullPage) – default: `false`
+- [`hideList`](#hideList) – default: `[]`
+- [`mapImageUrl`](#mapImageUrl) – default: `defaultMapImageUrl()`
+- [`mapPageUrl`](#mapPageUrl) – default: `defaultMapPageUrl()`
+- [`pageLinkOptions`](#pageLinkOptions) – default: `undefined`
+
+### `blockMap`
+
+– the blocks part of a Notion API response.
+A list of blocks by their id that may contain contents and properties.
+
+### `contentId`
+
+– the id of the block that should be rendered.
+If this is `undefined` the _first_ block is rendered.
+_Usually the first block contains the rest of the page._
+
+### `fullPage`
+
+– wether or not the page should contain the cover and header.
+
+### `hideList`
+
+– a list of Notion blocks (e.g. `"callout"`) that should not be rendered.
+
+### `mapImageUrl`
+
+– a method that receives `(imageUrl: String, block: Object)` and returns a `url: String` that should be used during rendering.
+The default method resolves images as they are used in Notion.
+
+> This method could be used to upload the Notion hosted images to an own provider and replace the image URLs with new ones.
+
+### `mapPageUrl`
+
+– a method that receives `(pageId: String)` and returns a `url: String` that should be used during rendering.
+The default method resolves pageIds relative to the current page root – i.e., `<pageId>` will become `/<pageId>`
+
+e.g. if you're using vue-notion for blog posts at `/posts/<pageId>`
+
+```js
+mapPageUrl(pageId = "") {
+  pageId = pageId.replace(/-/g, "");
+  return `/posts/${pageId}`;
+}
+```
+
+### `pageLinkOptions`
+
+– are used to override links to other Notion pages with custom Vue components.
+`pageLinkOptions` is an `Object` that requires a `component` and a `href` parameter.
+
+e.g. to use `NuxtLink` components instead of HTML `a` elements
+
+```js
+pageLinkOptions: {
+  component: "NuxtLink",
+  href: "to"
+}
+```
 
 ## Notion API
 
@@ -32,11 +94,13 @@ There are a few required steps to allow Nuxt to work with vue-notion
 
 - Install vue-notion as a dependency to your Nuxt project – `npm install vue-notion`
 - Add `"vue-notion"` to the `build.transpile` array in `nuxt.config.js`.
+
 ```js
 build: {
-  transpile: ["vue-notion"]
+  transpile: ["vue-notion"];
 }
 ```
+
 - Import the `NotionRenderer` in any component you want to use vue-notion in – `import { NotionRenderer } from "vue-notion"`
 - Voila, you can now use vue-notion as shown in the examples.