{"plugin":{"id":7,"name":"auto-sitemap","icon":"🗺️","description":"Generate site map from your builded entrypoints","longDescription":"# Auto sitemap\n\nFrame-Master plugin for automatically generating sitemaps for your static site.\n\n\n## Features\n\n- **Automatic Generation**: Automatically scans build outputs and adds relevant files to the sitemap.\n- **Sitemap Splitting**: Automatically splits the sitemap into multiple files if the number of entries exceeds `maxEntries`.\n- **Sitemap Index**: Generates a `sitemap.xml` index file when splitting occurs.\n- **Custom Entries**: Easily add custom URLs that are not part of the build output.\n- **Custom Parsing**: Hook into the generation process to modify URLs or add metadata (priority, changefreq) to auto-generated entries.\n- **Filtering**: Control which file types are included via `authorizedExtensions`.\n\n## Configuration\n\n| Option                    | Type             | Default                              | Description                                                                                                               |\n| ------------------------- | ---------------- | ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------- |\n| `baseUrl`                 | `string`         | **Required**                         | The base URL of your website (e.g., `https://example.com`). Required for generating valid sitemap URLs and sitemap index. |\n| `maxEntries`              | `number`         | `5000`                               | Maximum number of URLs per sitemap file. If exceeded, multiple sitemap files and a sitemap index will be generated.       |\n| `authorizedExtensions`    | `string[]`       | `['html', 'js', 'txt', 'md', 'mdx']` | List of file extensions to include in the sitemap from the build output.                                                  |\n| `disableAutoEntries`      | `boolean`        | `false`                              | If `true`, disables automatic generation of entries from build outputs.                                                   |\n| `siteMapEntries`          | `sitemapEntry[]` | `[]`                                 | Array of custom sitemap entries to add manually.                                                                          |\n| `parseAutoSiteMapEntries` | `function`       | `(entry) => entry`                   | Function to transform automatically generated entries before adding them to the sitemap.                                  |\n","version":"0.1.0","compatibleVersions":"^2.0.0","author":"Justin Halle","ownerId":"c166cdde-5f5c-40e5-a3ff-236652fa88a9","category":"utilities","tags":["site-map","static"],"published":true,"npmPackage":"frame-master-plugin-auto-sitemap","githubUrl":"https://github.com/shpaw415/frame-master-plugin-auto-sitemap","docsUrl":"","installation":"bun add frame-master-plugin-auto-sitemap","quickStart":"// all entrypoints with specified extentions: html,js,etc...\n// will be parsed and added to the site map","configuration":"import type { FrameMasterConfig } from \"frame-master/server/types\";\nimport autositemap from \"auto-sitemap\";\n\nconst config: FrameMasterConfig = {\n  HTTPServer: { port: 3000 },\n  plugins: [\n    autositemap({\n      baseUrl: \"https://example.com\", // Required\n      maxEntries: 5000, // Optional, default: 5000\n      // authorizedExtensions: ['html', 'js', 'txt', 'md', 'mdx'], // Optional\n      // disableAutoEntries: false, // Optional\n      // siteMapEntries: [ ... ], // Optional: Add custom entries\n    }),\n  ],\n};\n\nexport default config;\n","upvote":0,"downvote":0,"createdAt":"2025-12-02T20:21:04.000Z","updatedAt":"2026-04-08T14:56:49.000Z","dependencies":[]}}