@docmd/plugin-seo 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,18 @@
+# @docmd/plugin-seo
+
+Generates Meta tags, Open Graph (Facebook), and Twitter Card data for **docmd**.
+
+## Configuration
+```javascript
+// docmd.config.js
+module.exports = {
+  plugins: {
+    seo: {
+      defaultDescription: 'My documentation site',
+      twitter: {
+        siteUsername: '@myproject'
+      }
+    }
+  }
+}
+```

package/index.js

@@ -0,0 +1,77 @@
+/**
+ * Generates HTML meta tags for a specific page.
+ * @param {Object} config - Project config
+ * @param {Object} pageData - { frontmatter, outputPath }
+ * @param {string} relativePathToRoot - Path relative to root (for assets)
+ * @returns {string} HTML string of meta tags
+ */
+function generateMetaTags(config, pageData, relativePathToRoot) {
+  let html = '';
+  const { frontmatter, outputPath } = pageData;
+  const seo = frontmatter.seo || {}; // Page-specific SEO overrides
+  const globalSeo = config.plugins?.seo || {};
+
+  // 1. Robots
+  if (frontmatter.noindex || seo.noindex) {
+    return '<meta name="robots" content="noindex">\n';
+  }
+
+  // 2. Basic Meta
+  const siteTitle = config.siteTitle;
+  const pageTitle = frontmatter.title || 'Untitled';
+  const description = seo.description || frontmatter.description || globalSeo.defaultDescription || '';
+  
+  html += `<meta name="description" content="${description}">\n`;
+
+  // 3. Canonical URL
+  const siteUrl = config.siteUrl ? config.siteUrl.replace(/\/$/, '') : '';
+  // Convert "guide/index.html" -> "/guide/"
+  const urlPath = outputPath.replace(/(^|\/)index\.html$/, '$1'); 
+  const pageUrl = `${siteUrl}/${urlPath.replace(/^\//, '')}`;
+  
+  const canonical = seo.canonicalUrl || frontmatter.canonicalUrl || pageUrl;
+  if(canonical) {
+      html += `<link rel="canonical" href="${canonical}">\n`;
+  }
+
+  // 4. Open Graph (Facebook/LinkedIn)
+  html += `<meta property="og:title" content="${pageTitle} : ${siteTitle}">\n`;
+  html += `<meta property="og:description" content="${description}">\n`;
+  html += `<meta property="og:url" content="${pageUrl}">\n`;
+  html += `<meta property="og:type" content="${seo.ogType || frontmatter.ogType || 'website'}">\n`;
+
+  // Image Logic
+  let image = seo.image || frontmatter.image || globalSeo.openGraph?.defaultImage;
+  if (image) {
+    if (!image.startsWith('http')) {
+      // Resolve relative image path to absolute URL
+      image = `${siteUrl}/${image.replace(/^\.?\//, '')}`;
+    }
+    html += `<meta property="og:image" content="${image}">\n`;
+  }
+
+  // 5. Twitter
+  const cardType = seo.twitterCard || globalSeo.twitter?.cardType || 'summary_large_image';
+  html += `<meta name="twitter:card" content="${cardType}">\n`;
+  
+  if (globalSeo.twitter?.siteUsername) {
+    html += `<meta name="twitter:site" content="${globalSeo.twitter.siteUsername}">\n`;
+  }
+  
+  html += `<meta name="twitter:title" content="${pageTitle}">\n`;
+  html += `<meta name="twitter:description" content="${description}">\n`;
+  if (image) {
+    html += `<meta name="twitter:image" content="${image}">\n`;
+  }
+
+  // 6. Keywords
+  const keywords = seo.keywords || frontmatter.keywords;
+  if (keywords) {
+    const kwStr = Array.isArray(keywords) ? keywords.join(', ') : keywords;
+    html += `<meta name="keywords" content="${kwStr}">\n`;
+  }
+
+  return html;
+}
+
+module.exports = { generateMetaTags };

package/package.json

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