@docsector/docsector-reader 0.9.1 → 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.1'
+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.1",
+  "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/components/DPageBar.vue

@@ -93,16 +93,15 @@ const MCP_PATHS = [
   'M14.485 4.703a.823.823 0 000-1.18.863.863 0 00-1.204 0l-7.119 6.982a4.115 4.115 0 000 5.9 4.314 4.314 0 006.016 0l7.12-6.982a.823.823 0 000-1.18.863.863 0 00-1.204 0l-7.119 6.982a2.588 2.588 0 01-3.61 0 2.47 2.47 0 010-3.54l7.12-6.982z'
 ]
 const VSCODE_PATH = 'M70.9119 99.3171C72.4869 99.9307 74.2828 99.8914 75.8725 99.1264L96.4608 89.2197C98.6242 88.1787 100 85.9892 100 83.5872V16.4133C100 14.0113 98.6243 11.8218 96.4609 10.7808L75.8725 0.873756C73.7862 -0.130129 71.3446 0.11576 69.5135 1.44695C69.252 1.63711 69.0028 1.84943 68.769 2.08341L29.3551 38.0415L12.1872 25.0096C10.589 23.7965 8.35363 23.8959 6.86933 25.2461L1.36303 30.2549C-0.452552 31.9064 -0.454633 34.7627 1.35853 36.417L16.2471 50.0001L1.35853 63.5832C-0.454633 65.2374 -0.452552 68.0938 1.36303 69.7453L6.86933 74.7541C8.35363 76.1043 10.589 76.2037 12.1872 74.9905L29.3551 61.9587L68.769 97.9167C69.3925 98.5406 70.1246 99.0104 70.9119 99.3171ZM75.0152 27.2989L45.1091 50.0001L75.0152 72.7012V27.2989Z'
-const CODEX_PATH = 'M15.672 11.249a.75.75 0 00-.006-1.5 3.504 3.504 0 01-3.26-2.26.75.75 0 00-1.392 0 3.504 3.504 0 01-3.26 2.26.75.75 0 000 1.5 3.504 3.504 0 013.258 2.252.75.75 0 001.396-.004A3.504 3.504 0 0115.672 11.249zM21.665 7.317a.75.75 0 000-1.5 5.253 5.253 0 01-4.887-3.386.75.75 0 00-1.392 0A5.253 5.253 0 0110.5 5.817a.75.75 0 000 1.5 5.253 5.253 0 014.886 3.386.75.75 0 001.392 0 5.253 5.253 0 014.887-3.386z'
-
 const mcpIcon = computed(() => buildIconURI(MCP_PATHS, 'evenodd'))
 
-function buildVSCodeIconURI () {
-  const svg = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><path fill-rule="evenodd" clip-rule="evenodd" d="${VSCODE_PATH}" fill="%23007ACC"/></svg>`
+function buildVSCodeIconURI (color) {
+  const svg = `<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 100 100"><path fill-rule="evenodd" clip-rule="evenodd" d="${VSCODE_PATH}" fill="%23${color}"/></svg>`
   return `img:data:image/svg+xml,${svg}`
 }
-const vscodeIcon = computed(() => buildVSCodeIconURI())
-const codexIcon = computed(() => buildIconURI(CODEX_PATH))
+const vscodeIcon = computed(() => buildVSCodeIconURI('007ACC'))
+const vscodeInsidersIcon = computed(() => buildVSCodeIconURI('24bfa5'))
+const codexIcon = computed(() => buildIconURI(OPENAI_PATH))
 
 const mcpURL = computed(() => {
   if (!docsectorConfig.mcp) return null
@@ -116,6 +115,13 @@ const vscodeMcpURL = computed(() => {
   return `vscode:mcp/install?${encodeURIComponent(JSON.stringify({ name, url }))}`
 })
 
+const vscodeInsidersMcpURL = computed(() => {
+  if (!docsectorConfig.mcp) return null
+  const name = docsectorConfig.mcp.serverName
+  const url = `${window.location.origin}/mcp`
+  return `vscode-insiders:mcp/install?${encodeURIComponent(JSON.stringify({ name, url }))}`
+})
+
 const claudeCodeCommand = computed(() => {
   if (!docsectorConfig.mcp) return null
   const name = docsectorConfig.mcp.serverName
@@ -246,6 +252,19 @@ const copyPage = () => {
           </q-item-section>
         </q-item>
 
+        <q-item clickable v-close-popup :href="vscodeInsidersMcpURL" class="q-py-sm">
+          <q-item-section avatar>
+            <q-icon :name="vscodeInsidersIcon" size="xs" />
+          </q-item-section>
+          <q-item-section>
+            <q-item-label>{{ t('page.connectVSCodeInsiders') }}</q-item-label>
+            <q-item-label caption>{{ t('page.connectVSCodeInsidersCaption') }}</q-item-label>
+          </q-item-section>
+          <q-item-section side>
+            <q-icon name="open_in_new" size="xs" />
+          </q-item-section>
+        </q-item>
+
         <q-item clickable v-close-popup @click="copyMcpCommand(claudeCodeCommand, 'claude')" class="q-py-sm">
           <q-item-section avatar>
             <q-icon :name="claudeIcon" size="xs" />

package/src/i18n/helpers.js

@@ -38,6 +38,8 @@ const engineDefaults = {
       mcpServerCaption: 'Connect AI assistants via MCP',
       connectVSCode: 'Connect to VSCode',
       connectVSCodeCaption: 'Use this MCP in VSCode',
+      connectVSCodeInsiders: 'Connect to VSCode Insiders',
+      connectVSCodeInsidersCaption: 'Use this MCP in VSCode Insiders',
       connectClaudeCode: 'Connect to Claude Code',
       connectClaudeCodeCaption: 'Use this MCP in Claude Code',
       connectCodex: 'Connect to Codex',
@@ -60,6 +62,8 @@ const engineDefaults = {
       mcpServerCaption: 'Conecte assistentes de IA via MCP',
       connectVSCode: 'Conectar ao VSCode',
       connectVSCodeCaption: 'Use este MCP no VSCode',
+      connectVSCodeInsiders: 'Conectar ao VSCode Insiders',
+      connectVSCodeInsidersCaption: 'Use este MCP no VSCode Insiders',
       connectClaudeCode: 'Conectar ao Claude Code',
       connectClaudeCodeCaption: 'Use este MCP no Claude Code',
       connectCodex: 'Conectar ao Codex',

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)