docs: nuxt content documentation (#172)

* docs: nuxt content documentation

* docs: update static and configuration

* docs(fr): add french documentation

* fix: nuxt config js prettier

* docs: update documentation link on README

Author: Geminii

README.md

@@ -0,0 +1,11 @@
+node_modules
+*.iml
+.idea
+*.log*
+.nuxt
+.vscode
+.DS_Store
+coverage
+dist
+sw.*
+.env

docs/.gitignore

@@ -0,0 +1,27 @@
+# docs
+
+## Setup
+
+Install dependencies:
+
+```bash
+yarn install
+```
+
+## Development
+
+```bash
+yarn dev
+```
+
+## Static Generation
+
+This will create the `dist/` directory for publishing to static hosting:
+
+```bash
+yarn generate
+```
+
+To preview the static generated app, run `yarn start`
+
+For detailed explanation on how things work, checkout [nuxt/content](https://content.nuxtjs.org) and [@nuxt/content theme docs](https://content.nuxtjs.org/themes-docs).

docs/README.md

@@ -0,0 +1,74 @@
+---
+title: Configuration
+description: ''
+position: 3
+category: Guide
+---
+
+Add a custom configuration with the `sitemap` property:
+
+```js[nuxt.config.js]
+{
+  modules: [
+    '@nuxtjs/sitemap'
+  ],
+  sitemap: {
+    // options
+  },
+}
+```
+
+The module option parameter can be:
+
+### `Object`
+
+A single item of [sitemap](/usage/sitemap) or [sitemap index](#sitemap-index-options):
+
+```js
+{
+  sitemap: {
+    // ...
+  },
+}
+```
+
+### `Array`
+
+A list of [sitemap](#sitemap-options) or [sitemap index](#sitemap-index-options) items:
+
+```js
+{
+  sitemap: [
+    {
+      // ...
+    },
+    {
+      // ...
+    },
+  ],
+}
+```
+
+### `Function`
+
+A function that returns a valid sitemap configuration:
+
+```js
+{
+  sitemap: function () {
+    return {
+      // ...
+    }
+  },
+}
+```
+
+### `Boolean`
+
+You can disable the sitemap module with a boolean value at `false`:
+
+```js
+{
+  sitemap: false
+}
+```

docs/content/en/guide/configuration.md

@@ -0,0 +1,43 @@
+---
+title: Setup
+description: ''
+position: 2
+category: Guide
+---
+
+## Installation
+
+Add `@nuxtjs/sitemap` dependency to your project:
+
+<code-group>
+  <code-block label="Yarn" active>
+
+  ```bash
+  yarn add @nuxtjs/sitemap
+  ```
+
+  </code-block>
+  <code-block label="NPM">
+
+  ```bash
+  npm install @nuxtjs/sitemap
+  ```
+
+  </code-block>
+</code-group>
+
+## Setup
+
+Add `@nuxtjs/sitemap` to the `modules` section of your `nuxt.config.js` file:
+
+```js[nuxt.config.js]
+{
+  modules: [
+    '@nuxtjs/sitemap'
+  ],
+}
+```
+
+> **notice:**  
+> If you use other modules (eg. `nuxt-i18n`), always declare the sitemap module at end of array  
+> eg. `modules: ['nuxt-i18n', '@nuxtjs/sitemap']`

docs/content/en/guide/setup.md

@@ -0,0 +1,35 @@
+---
+title: Introduction
+description: ''
+position: 1
+category: ''
+features:
+  - Module based on the awesome sitemap.js package ❤️
+  - Create sitemap or sitemap index
+  - Automatically add the static routes to each sitemap
+  - Support i18n routes from nuxt-i18n (latest version)
+  - Works with all modes (SSR, SPA, generate)
+  - For Nuxt 2.x and higher
+---
+
+<img src="/preview.png" class="light-img" width="1280" height="640" alt=""/>
+<img src="/preview-dark.png" class="dark-img" width="1280" height="640" alt=""/>
+
+[Nuxt Sitemap Module](https://github.com/nuxt-community/sitemap-module) for [NuxtJS](https://nuxtjs.org).
+
+Automatically generate or serve dynamic [sitemap.xml](https://github.com/ekalinin/sitemap.js) for Nuxt projects!
+
+## Features
+
+<list :items="features"></list>
+
+## More Resources
+
+* [GitHub](https://github.com/nuxt-community/sitemap-module)
+* [Releases](https://github.com/nuxt-community/sitemap-module/releases)
+* [MIT Licence](./LICENSE)
+
+## Contributors
+
+- [Nicolas Pennec](https://github.com/NicoPennec)
+- [Pooya Parsa](https://github.com/pi0)

docs/content/en/index.md

@@ -0,0 +1,15 @@
+---
+title: Hooks
+description: ''
+position: 7
+category: Usage
+---
+
+Hooks are listeners to Nuxt events. [Learn more](https://nuxtjs.org/api/configuration-hooks)
+
+You can register hooks on certain life cycle events.
+
+| Hook  | Arguments  | When  | 
+|---|---|---|
+| sitemap:generate:before  | (nuxt, sitemapOptions)  | Hook on before site generation  |
+| sitemap:generate:done  |  (nuxt) | Hook on sitemap generation finished |

docs/content/en/usage/hooks.md

@@ -0,0 +1,60 @@
+---
+title: Sitemap index
+description: ''
+position: 5
+category: Usage
+---
+
+### Setup a Sitemap Index
+
+To declare a sitemap index and its linked sitemaps, use the [`sitemaps`](/usage/sitemap-options#sitemaps---array-of-object) property.
+
+By default, the sitemap index is setup to the following path: `/sitemapindex.xml`  
+
+Each item of the `sitemaps` array can be setup with its own [sitemap options](/usage/sitemap-options).
+
+```js[nuxt.config.js]
+{
+  sitemap: {
+    hostname: 'https://example.com',
+    lastmod: '2017-06-30',
+    sitemaps: [
+      {
+        path: '/sitemap-foo.xml',
+        routes: ['foo/1', 'foo/2'],
+        gzip: true
+      }, {
+        path: '/folder/sitemap-bar.xml',
+        routes: ['bar/1', 'bar/2'],
+        exclude: ['/**']
+      }
+    ]
+  }
+}
+```
+
+### Setup a list of sitemaps
+
+To declare a list of sitemaps, use an `array` to setup each sitemap with its own configuration.  
+You can combine sitemap and sitemap index configurations.
+
+```js[nuxt.config.js]
+{
+  sitemap: [
+    {
+      path: '/sitemap-products.xml',
+      routes: [
+        // array of URL
+      ]
+    }, {
+      path: '/sitemap-news.xml',
+      routes: () => // promise or function
+    }, {
+      path: '/sitemapindex.xml',
+      sitemaps: [{
+        // array of Sitemap configuration
+      }]
+    }
+  }
+}
+```