@docsector/docsector-reader 0.9.2 → 0.10.0

package/README.md

@@ -27,6 +27,7 @@ Transform Markdown content into beautiful, navigable documentation sites — wit
 - 🗺️ **Sitemap Generation** — Automatic `sitemap.xml` generation at build time with all page URLs (requires `siteUrl` in config)
 - 🤖 **AI-Friendly robots.txt** — Scaffold includes a `robots.txt` explicitly allowing 23 AI crawlers (GPTBot, ClaudeBot, PerplexityBot, GrokBot, etc.)
 - 🔌 **MCP Server** — Auto-generated [MCP](https://modelcontextprotocol.io) server at `/mcp` for AI assistant integration (Claude Desktop, VS Code, etc.)
+- 📄 **llms.txt / llms-full.txt** — Auto-generated [llms.txt](https://llmstxt.org) index and full-content file for LLM discovery (requires `siteUrl` in config)
 
 ---
 
@@ -128,7 +129,31 @@ curl -X POST http://localhost:8788/mcp \
 
 ---
 
-## 🚀 Quick Start
+## � llms.txt (LLM Discovery)
+
+Docsector Reader automatically generates [llms.txt](https://llmstxt.org) files at build time when `siteUrl` is configured (same requirement as sitemap.xml).
+
+| File | Purpose |
+|---|---|
+| `/llms.txt` | Markdown index of all pages with links to `.md` versions, grouped by type |
+| `/llms-full.txt` | Full documentation content concatenated in a single file for LLM context |
+
+Optionally add a `description` to your branding for a richer `llms.txt` blockquote:
+
+```javascript
+export default {
+  branding: {
+    name: 'My Project',
+    version: 'v1.0.0',
+    description: 'A framework for building awesome things'
+  },
+  siteUrl: 'https://my-docs.example.com'
+}
+```
+
+---
+
+## �🚀 Quick Start
 
 ### 📦 Install
 

package/bin/docsector.js

@@ -23,7 +23,7 @@ const packageRoot = resolve(__dirname, '..')
 const args = process.argv.slice(2)
 const command = args[0]
 
-const VERSION = '0.9.2'
+const VERSION = '0.10.0'
 
 const HELP = `
   Docsector Reader v${VERSION}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docsector/docsector-reader",
-  "version": "0.9.2",
+  "version": "0.10.0",
   "description": "A documentation rendering engine built with Vue 3, Quasar v2 and Vite. Transform Markdown into beautiful, navigable documentation sites.",
   "productName": "Docsector Reader",
   "author": "Rodrigo de Araujo Vieira",

package/src/index.js

@@ -26,6 +26,7 @@
  * @param {string} config.branding.logo - Logo image path (relative to public/)
  * @param {string} config.branding.name - Project name displayed in sidebar
  * @param {string} config.branding.version - Version label
+ * @param {string} [config.branding.description] - Project description (used in llms.txt)
  * @param {string[]} [config.branding.versions] - Available versions for dropdown
  * @param {Object} config.links - External links
  * @param {string} [config.links.github] - GitHub repository URL

package/src/quasar.factory.js

@@ -467,6 +467,63 @@ function createMarkdownBuildPlugin (projectRoot) {
         const sitemap = `<?xml version="1.0" encoding="UTF-8"?>\n<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">\n${urls}</urlset>\n`
         writeFileSync(resolve(distDir, 'sitemap.xml'), sitemap)
         console.log(`\x1b[36m[docsector]\x1b[0m Generated sitemap.xml`)
+
+        // Generate llms.txt and llms-full.txt (LLM-friendly page index and full content)
+        const brandingName = config.branding?.name || 'Documentation'
+        const brandingVersion = config.branding?.version || ''
+        const brandingDesc = config.branding?.description || `${brandingName} documentation`
+
+        let llmsIndex = `# ${brandingName}${brandingVersion ? ' ' + brandingVersion : ''}\n\n> ${brandingDesc}\n\n`
+        let llmsFull = `# ${brandingName}${brandingVersion ? ' ' + brandingVersion : ''}\n\n> ${brandingDesc}\n\n---\n\n`
+
+        const llmsSections = {}
+
+        for (const [pagePath, page] of Object.entries(pages)) {
+          if (page.config === null) continue
+          if (page.config.status === 'empty') continue
+
+          const type = page.config.type ?? 'manual'
+          const title = page.data?.['*']?.title
+            || page.data?.[defaultLang]?.title
+            || page.data?.['en-US']?.title
+            || pagePath.split('/').pop()
+            || pagePath
+
+          const subpages = ['overview']
+          if (page.config.subpages?.showcase) subpages.push('showcase')
+          if (page.config.subpages?.vs) subpages.push('vs')
+
+          for (const subpage of subpages) {
+            const srcFile = resolve(pagesDir, `${type}${pagePath}.${subpage}.${defaultLang}.md`)
+            if (!existsSync(srcFile)) continue
+
+            const routePath = `${type}${pagePath}/${subpage}`
+            const mdUrl = `${siteUrl}/${routePath}.md`
+            const pageUrl = `${siteUrl}/${routePath}`
+
+            const desc = page.config.meta?.description
+            const descText = typeof desc === 'object' ? (desc[defaultLang] || desc['en-US'] || '') : (desc || '')
+
+            if (!llmsSections[type]) llmsSections[type] = []
+            llmsSections[type].push(
+              descText
+                ? `- [${title}](${mdUrl}): ${descText}`
+                : `- [${title}](${mdUrl})`
+            )
+
+            const content = readFileSync(srcFile, 'utf-8')
+            llmsFull += `## ${title}\n\nSource: ${pageUrl}\n\n${content}\n\n---\n\n`
+          }
+        }
+
+        for (const [section, entries] of Object.entries(llmsSections)) {
+          const sectionName = section.charAt(0).toUpperCase() + section.slice(1)
+          llmsIndex += `## ${sectionName}\n\n${entries.join('\n')}\n\n`
+        }
+
+        writeFileSync(resolve(distDir, 'llms.txt'), llmsIndex.trimEnd() + '\n')
+        writeFileSync(resolve(distDir, 'llms-full.txt'), llmsFull.trimEnd() + '\n')
+        console.log(`\x1b[36m[docsector]\x1b[0m Generated llms.txt and llms-full.txt`)
       }
 
       // Generate _headers file for Cloudflare Pages (append if exists)