add docs

facebook · May 27, 2022 · 5f5b992 · 5f5b992
1 parent 0e06c40
commit 5f5b992
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/packages/docusaurus-plugin-sitemap/src/options.ts b/packages/docusaurus-plugin-sitemap/src/options.ts
@@ -21,6 +21,7 @@ export type PluginOptions = {
   ignorePatterns: string[];
   /**
    * The path to the created sitemap file, relative to the output directory.
+   * Useful if you have two plugin instances outputting two files.
    */
   filename: string;
 };

diff --git a/website/docs/api/plugins/plugin-sitemap.md b/website/docs/api/plugins/plugin-sitemap.md
@@ -40,7 +40,7 @@ Accepted fields:
 | `changefreq` | `string` | `'weekly'` | See [sitemap docs](https://www.sitemaps.org/protocol.html#xmlTagDefinitions) |
 | `priority` | `number` | `0.5` | See [sitemap docs](https://www.sitemaps.org/protocol.html#xmlTagDefinitions) |
 | `ignorePatterns` | `string[]` | `[]` | A list of glob patterns; matching route paths will be filtered from the sitemap. Note that you may need to include the base URL in here. |
-| `filename` | `string` | `sitemap.xml` | The path to the created sitemap file, relative to the output directory. |
+| `filename` | `string` | `sitemap.xml` | The path to the created sitemap file, relative to the output directory. Useful if you have two plugin instances outputting two files. |
 
 </APITable>
 
@@ -71,6 +71,7 @@ const config = {
   changefreq: 'weekly',
   priority: 0.5,
   ignorePatterns: ['/tags/**'],
+  filename: 'sitemap.xml',
 };
 ```