feat: intergrate sitemap (#28)

Author: billyyyyy3320

docs/config/README.md

@@ -188,3 +188,18 @@ Pagination config for all directories and frontmatters.
 - Required: `false`
 
 Please head to [Pagination Config](../pagination/README.md#config) section to get all available options.
+
+## sitemap
+
+- Type: `object`
+- Default: `{}`
+- Required: `false`
+
+It will be enabled when `hostname` is provided. e.g.
+
+```js
+{
+  hostname: 'https://yourdomain'
+}
+```
+The 404 page is excluded by default. Further options, please head to [vuepress-plugin-sitemap](https://github.com/ekoeryanto/vuepress-plugin-sitemap#options).

examples/blog/.vuepress/config.js

@@ -41,6 +41,9 @@ module.exports = {
       ],
       globalPagination: {
         lengthPerPage: 5
+      },
+      sitemap: {
+        hostname: 'https://yourdomain'
       }
     }],
   ],

package.json

@@ -29,7 +29,8 @@
   "author": "ULIVZ <[email protected]>",
   "license": "MIT",
   "dependencies": {
-    "vuejs-paginate": "^2.1.0"
+    "vuejs-paginate": "^2.1.0",
+    "vuepress-plugin-forked-sitemap": "^0.0.1"
   },
   "devDependencies": {
     "concurrently": "^4.1.0",

src/node/index.ts

@@ -32,6 +32,17 @@ module.exports = (options: BlogPluginOptions, ctx: VuePressContext) => {
     paginations,
   } = handleOptions(options, ctx)
 
+  /**
+   * Leverage other plugins
+   */
+  let plugins
+
+  if (options.sitemap && options.sitemap.hostname) {
+    const sitemapOptions = { ...options.sitemap, exclude: ['/404.html'] }
+    // Temporarily use a fork of vuepress-plugin-sitemap. Should switch back when it release the next version.
+    plugins = [['vuepress-plugin-forked-sitemap', sitemapOptions], ['@vuepress/last-updated']]
+  }
+
   return {
     name: 'vuepress-plugin-blog',
 
@@ -195,6 +206,8 @@ export default ${serializePaginations(ctx.serializedPaginations, [
       path.resolve(__dirname, '../client/classification.js'),
       path.resolve(__dirname, '../client/pagination.js'),
     ],
+
+    plugins
   }
 }
 

src/node/interface/Options.ts

@@ -83,5 +83,6 @@ export interface FrontmatterClassifier {
 export interface BlogPluginOptions {
   directories: DirectoryClassifier[];
   frontmatters: FrontmatterClassifier[];
-  globalPagination: PaginationConfig
+  globalPagination: PaginationConfig;
+  sitemap:any
 }