- Added documentation

README.md

@@ -1,3 +1,37 @@
-# fullstack-template
+# next-sitemap
 
-Fullstack project template
+Sitemap generator for next.js
+
+## Install
+
+```shell
+yarn add next-sitemap -D
+```
+
+## Create config file
+
+`next-sitemap` requires a basic config file (`next-sitemap.js`) under your project root
+
+```js
+module.exports = {
+  siteUrl: 'https://example.com'
+  // other options
+}
+```
+
+## Add next-sitemap as your postbuild script
+
+```json
+{
+  "build": "next build",
+  "postbuild": "next-sitemap"
+}
+```
+
+## `next-sitemap.js` Options
+
+| property              | description                          |
+| --------------------- | ------------------------------------ |
+| siteUrl               | Base url of your website             |
+| changefreq (optional) | Change frequency. Default to `daily` |
+| priority (optional)   | Priority. Default to `0.7`           |

packages/next-sitemap/src/export/index.ts

@@ -1,5 +1,11 @@
 import fs from 'fs'
+import path from 'path'
 
-export const exportSitemap = (path: string, xml: string) => {
-  fs.writeFileSync(path, xml)
+export const exportSitemap = (filePath: string, xml: string) => {
+  const folder = path.dirname(filePath)
+  if (!fs.existsSync(folder)) {
+    fs.mkdirSync(folder)
+  }
+
+  fs.writeFileSync(filePath, xml)
 }

packages/next-sitemap/src/index.ts

@@ -11,6 +11,4 @@ const urlSet = createUrlSet(config, manifest)
 const sitemapPath = config.path
 const sitemapXml = buildSitemapXml(config, [...urlSet])
 
-console.log(sitemapPath)
-
 exportSitemap(sitemapPath, sitemapXml)

packages/next-sitemap/src/path.ts

@@ -7,7 +7,7 @@ export const getPath = (rel: string) => {
 const allPath = {
   NEXT_MANIFEST: getPath('.next/build-manifest.json'),
   PRERENDER_MANIFEST: getPath('.next/prerender-manifest.json'),
-  CONFIG_FILE: getPath('next.sitemap.js')
+  CONFIG_FILE: getPath('next-sitemap.js')
 }
 
 export default allPath