@docsector/docsector-reader 4.5.4 → 4.5.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +1 -0
- package/bin/docsector.js +41 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -78,6 +78,7 @@ Transform Markdown content into beautiful, navigable documentation sites — wit
|
|
|
78
78
|
- 🌍 **Remote README as Home** — Optional build-time remote README source for homepage with automatic local fallback and automatic primary-title handoff when the remote README already provides the project heading
|
|
79
79
|
- 🔗 **GitHub-Compatible Heading Anchors** — Markdown headings use GitHub-style slugs so standard README Table of Contents links work inside Docsector
|
|
80
80
|
- 🧬 **Scaffolded Homepage Override Wiring** — New consumer projects automatically wire `virtual:docsector-homepage-override` into i18n message building
|
|
81
|
+
- 🤖 **Scaffolded AI Assistant Config** — New consumer projects include a ready-to-enable `aiAssistant` example in `docsector.config.js` so the built-in assistant is visible in the default scaffold
|
|
81
82
|
- 🧰 **Scaffolded Dev Reliability** — New consumer projects protect Docsector virtual registries and Markdown CommonJS plugins from Vite optimizer edge cases during dev and build
|
|
82
83
|
- 📖 **Expandable Markdown Sections** — Use `<d-block-expandable title="...">...</d-block-expandable>` to collapse secondary content while keeping rich Markdown support inside the body
|
|
83
84
|
- 1️⃣ **Stepper Guides** — Use `<d-block-stepper>` with nested `<d-block-step title="...">...</d-block-step>` items to render native Quasar vertical steppers with rich Markdown and optional per-step icon overrides
|
package/bin/docsector.js
CHANGED
|
@@ -24,7 +24,7 @@ const packageRoot = resolve(__dirname, '..')
|
|
|
24
24
|
const args = process.argv.slice(2)
|
|
25
25
|
const command = args[0]
|
|
26
26
|
|
|
27
|
-
const VERSION = '4.5.
|
|
27
|
+
const VERSION = '4.5.5'
|
|
28
28
|
const AUTHORING_SKILL_NAME = 'docsector-documentation-authoring'
|
|
29
29
|
const AUTHORING_SKILL_DESCRIPTION = 'Author Docsector documentation with Markdown, custom blocks, MCP, and WebMCP.'
|
|
30
30
|
const AUTHORING_SKILL_PUBLIC_PATH = `/.well-known/agent-skills/${AUTHORING_SKILL_NAME}/SKILL.md`
|
|
@@ -182,6 +182,46 @@ export default {
|
|
|
182
182
|
defaultLanguage: 'en-US'
|
|
183
183
|
|
|
184
184
|
// --- AI configs ---
|
|
185
|
+
// @ AI Assistant (optional)
|
|
186
|
+
// Customize the built-in AI assistant or disable it if not needed.
|
|
187
|
+
// aiAssistant: {
|
|
188
|
+
// enabled: true,
|
|
189
|
+
// provider: 'aiSearch',
|
|
190
|
+
// endpoint: '/assistant',
|
|
191
|
+
// ui: {
|
|
192
|
+
// title: 'Docsector AI Assistant',
|
|
193
|
+
// subtitle: 'Ask, search, or explore the documentation.',
|
|
194
|
+
// drawerWidth: 380,
|
|
195
|
+
// wideBreakpoint: 1280,
|
|
196
|
+
// showCitations: true,
|
|
197
|
+
// suggestedPrompts: [
|
|
198
|
+
// 'How do I get started?',
|
|
199
|
+
// 'Summarize this page.',
|
|
200
|
+
// 'Where is the related API reference?'
|
|
201
|
+
// ]
|
|
202
|
+
// },
|
|
203
|
+
// aiSearch: {
|
|
204
|
+
// binding: 'AI_SEARCH',
|
|
205
|
+
// instanceNameEnv: 'AI_SEARCH_INSTANCE_NAME',
|
|
206
|
+
// namespace: '',
|
|
207
|
+
// accountIdEnv: 'CLOUDFLARE_ACCOUNT_ID',
|
|
208
|
+
// apiTokenEnv: 'CLOUDFLARE_API_TOKEN',
|
|
209
|
+
// model: '@cf/meta/llama-4-scout-17b-16e-instruct',
|
|
210
|
+
// retrievalType: 'vector',
|
|
211
|
+
// maxResults: 10,
|
|
212
|
+
// matchThreshold: 0.4,
|
|
213
|
+
// contextExpansion: 1,
|
|
214
|
+
// queryRewrite: {
|
|
215
|
+
// enabled: false
|
|
216
|
+
// },
|
|
217
|
+
// reranking: {
|
|
218
|
+
// enabled: false,
|
|
219
|
+
// model: '@cf/baai/bge-reranker-base',
|
|
220
|
+
// matchThreshold: 0.4
|
|
221
|
+
// },
|
|
222
|
+
// stream: true
|
|
223
|
+
// }
|
|
224
|
+
// },
|
|
185
225
|
|
|
186
226
|
// @ MCP (Model Context Protocol)
|
|
187
227
|
// Uncomment to enable an MCP server at /mcp for AI assistant integration.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docsector/docsector-reader",
|
|
3
|
-
"version": "4.5.
|
|
3
|
+
"version": "4.5.5",
|
|
4
4
|
"description": "A documentation rendering engine built with Vue 3, Quasar v2 and Vite. Transform Markdown into beautiful, navigable documentation sites.",
|
|
5
5
|
"productName": "Docsector Reader",
|
|
6
6
|
"author": "Rodrigo de Araujo Vieira",
|