@docmd/plugin-sitemap 0.4.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 docmd (docmd.io)
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,19 @@
+# @docmd/plugin-sitemap
+
+Automatically generates `sitemap.xml` for **docmd** sites.
+
+**Note:** You must set `siteUrl` in your `docmd.config.js` for this plugin to work.
+
+## Configuration
+```javascript
+// docmd.config.js
+module.exports = {
+  siteUrl: 'https://mysite.com', // Required
+  plugins: {
+    sitemap: {
+      defaultChangefreq: 'weekly',
+      defaultPriority: 0.8
+    }
+  }
+}
+```

package/index.js

@@ -0,0 +1,68 @@
+const path = require('path');
+const fs = require('fs/promises');
+
+/**
+ * Hook to run after the build is complete.
+ * @param {Object} context
+ * @param {Object} context.config - The parsed project config
+ * @param {Array} context.pages - Array of page objects { outputPath, frontmatter }
+ * @param {string} context.outputDir - Absolute path to output directory
+ * @param {Function} context.log - Logger function
+ */
+async function onPostBuild({ config, pages, outputDir, log }) {
+  // 1. Check if enabled
+  if (config.plugins?.sitemap === false || !config.siteUrl) {
+    if (!config.siteUrl && log) log('⚠️  Skipping sitemap: "siteUrl" is missing in config.');
+    return;
+  }
+
+  const siteUrl = config.siteUrl.replace(/\/$/, '');
+  
+  // 2. Build XML Header
+  let sitemapXml = '<?xml version="1.0" encoding="UTF-8"?>\n';
+  sitemapXml += '<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n';
+
+  // 3. Defaults
+  const defaultChangefreq = config.plugins?.sitemap?.defaultChangefreq || 'weekly';
+  const defaultPriority = config.plugins?.sitemap?.defaultPriority || 0.8;
+  const rootPriority = config.plugins?.sitemap?.rootPriority || 1.0;
+
+  // 4. Loop Pages
+  for (const page of pages) {
+    const fm = page.frontmatter || {};
+    
+    // Skip hidden pages
+    if (fm.sitemap === false || fm.noindex === true) continue;
+
+    const pagePath = page.outputPath; // e.g. "guide/index.html"
+    let url = siteUrl;
+
+    // URL Construction Logic
+    if (pagePath === 'index.html') {
+      url += '/';
+    } else if (pagePath.endsWith('/index.html')) {
+      url += '/' + pagePath.replace('/index.html', '/');
+    } else {
+      url += '/' + pagePath;
+    }
+
+    // Metadata Logic
+    let priority = fm.priority || (pagePath === 'index.html' ? rootPriority : defaultPriority);
+    const changefreq = fm.changefreq || defaultChangefreq;
+
+    sitemapXml += '  <url>\n';
+    sitemapXml += `    <loc>${url}</loc>\n`;
+    if (fm.lastmod) sitemapXml += `    <lastmod>${fm.lastmod}</lastmod>\n`;
+    sitemapXml += `    <changefreq>${changefreq}</changefreq>\n`;
+    sitemapXml += `    <priority>${priority}</priority>\n`;
+    sitemapXml += '  </url>\n';
+  }
+
+  sitemapXml += '</urlset>';
+
+  // 5. Write File
+  await fs.writeFile(path.join(outputDir, 'sitemap.xml'), sitemapXml);
+  if (log) log('✅ Sitemap generated.');
+}
+
+module.exports = { onPostBuild };

package/package.json

@@ -0,0 +1,7 @@
+{
+  "name": "@docmd/plugin-sitemap",
+  "version": "0.4.0",
+  "description": "Sitemap generator plugin for docmd",
+  "main": "index.js",
+  "license": "MIT"
+}