@docsector/docsector-reader 4.5.5 โ 4.5.6
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 -5
- package/bin/docsector.js +5 -5
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -34,6 +34,7 @@ Transform Markdown content into beautiful, navigable documentation sites โ wit
|
|
|
34
34
|
- ๐ชช **MCP Server Card** โ Optional `/.well-known/mcp/server-card.json` for MCP server discovery before connection
|
|
35
35
|
- ๐ **WebMCP Browser Tools** โ Optional registration of in-page tools via `navigator.modelContext` for browser agents
|
|
36
36
|
- ๐ค **AI Assistant Panel** โ Optional documentation assistant drawer backed by Cloudflare AI Search through an internal same-origin endpoint
|
|
37
|
+
- ๐๏ธ **API Catalog Well-Known** โ Auto-generates `/.well-known/api-catalog` as Linkset JSON for machine-readable API discovery
|
|
37
38
|
- ๐ **Homepage Link Headers** โ Auto-generated `Link` response headers for agent discovery (`api-catalog`, `service-doc`, `service-desc`, `describedby`) per RFC 8288 / RFC 9727
|
|
38
39
|
- ๐ **MCP Server** โ Auto-generated [MCP](https://modelcontextprotocol.io) server at `/mcp` for AI assistant integration (Claude Desktop, VS Code, etc.)
|
|
39
40
|
- ๐ **llms.txt / llms-full.txt** โ Auto-generated [llms.txt](https://llmstxt.org) index and full-content file for LLM discovery (requires `siteUrl` in config)
|
|
@@ -77,9 +78,6 @@ Transform Markdown content into beautiful, navigable documentation sites โ wit
|
|
|
77
78
|
- ๐งฑ **Configurable Homepage Layout** โ Set `homePage.layout` to `default` or `fullwidth`; fullwidth keeps the header and book tabs while removing the sidebar, subpage toolbar, Table of Contents, and homepage footer
|
|
78
79
|
- ๐ **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
80
|
- ๐ **GitHub-Compatible Heading Anchors** โ Markdown headings use GitHub-style slugs so standard README Table of Contents links work inside Docsector
|
|
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
|
|
82
|
-
- ๐งฐ **Scaffolded Dev Reliability** โ New consumer projects protect Docsector virtual registries and Markdown CommonJS plugins from Vite optimizer edge cases during dev and build
|
|
83
81
|
- ๐ **Expandable Markdown Sections** โ Use `<d-block-expandable title="...">...</d-block-expandable>` to collapse secondary content while keeping rich Markdown support inside the body
|
|
84
82
|
- 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
|
|
85
83
|
- ๐ **Timeline Updates** โ Use `<d-block-timeline>` with nested `<d-block-timeline-item date="...">...</d-block-timeline-item>` entries and optional `<d-block-timeline-tag>` labels to publish GitBook-inspired changelog items with direct-link anchors, tag icons/colors, and rich Markdown bodies
|
|
@@ -88,13 +86,11 @@ Transform Markdown content into beautiful, navigable documentation sites โ wit
|
|
|
88
86
|
- ๐งญ **Quick Links Custom Element** โ Use `<d-block-quick-links>` and `<d-block-quick-link>` in Markdown to render rich home navigation cards
|
|
89
87
|
- ๐๏ธ **Cards Custom Element** โ Use `<d-block-cards>` and `<d-block-card>` in Markdown to render linked content cards with optional cover images
|
|
90
88
|
- ๐งพ **API JSON Reference Block** โ Use `<d-block-api src="..." />` in Markdown to render Quasar-compatible API reference UIs from public JSON assets without inventing a new schema
|
|
91
|
-
- ๐๏ธ **API Catalog Well-Known** โ Auto-generates `/.well-known/api-catalog` as Linkset JSON for machine-readable API discovery
|
|
92
89
|
- ๐ง **Docsector Authoring Skill Docs** โ Documents the built-in `SKILL.md` and reference files so agents can learn Docsector blocks, page patterns, MCP lookup, and WebMCP tools from a public manual page
|
|
93
90
|
- ๐๏ธ **Multi-Version History** โ Archive older major versions under `src/pages/.old/<version>/` and expose them at prefixed routes (e.g. `/v0.x/guide/...`) while keeping the current docs at unprefixed routes
|
|
94
91
|
- ๐ท๏ธ **Version Selector Badges** โ Every version in the sidebar selector displays a color-coded badge: green for released, orange for draft, red for deprecated; fully customizable via `badge: { label, color, textColor }`
|
|
95
92
|
- ๐ **Tabbed Code Blocks** โ Group consecutive fenced code blocks into tabs using the `group` and `tab` attributes in the fence info line
|
|
96
93
|
- ๐งช **Live Code Example Blocks** โ Use `<d-block-code-example src="..." />` to render bundled Vue SFC examples with a live preview, GitHub source link, source toggle, and CodePen export for compatible examples
|
|
97
|
-
- ๐ **Accurate Source Code Line Counts** โ Code example headers count visible lines correctly across LF, CRLF, and terminal newlines without inflating the total
|
|
98
94
|
- ๐ **Breadcrumb Path Display** โ Show a file path breadcrumb above code blocks with the `breadcrumb` attribute; renders as clickable path segments
|
|
99
95
|
- ๐จ **File Type Icons** โ Automatically resolves file extension or filename to a Material Icon Theme SVG icon, shown inline in tabs and beside the last breadcrumb segment
|
|
100
96
|
- โ๏ธ **Single Config File** โ Customize branding, links, and languages via `docsector.config.js`
|
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.6'
|
|
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`
|
|
@@ -553,15 +553,15 @@ const TEMPLATE_HOMEPAGE_MD = `\
|
|
|
553
553
|
|
|
554
554
|
Docsector Reader is a markdown-first documentation engine.
|
|
555
555
|
|
|
556
|
+
Give us a star on GitHub: [docsector/docsector-reader](https://github.com/docsector/docsector-reader)
|
|
557
|
+
|
|
556
558
|
## Quick Links
|
|
557
559
|
|
|
558
560
|
- [Getting Started](/guide/getting-started/overview/)
|
|
559
|
-
- [Configuration](/guide/configuration/overview/)
|
|
560
|
-
- [Pages and Routing](/guide/pages-and-routing/overview/)
|
|
561
561
|
|
|
562
|
-
##
|
|
562
|
+
## Demo
|
|
563
563
|
|
|
564
|
-
|
|
564
|
+
Check out the [docsector.com](https://docsector.com) to see all the features in action!
|
|
565
565
|
`
|
|
566
566
|
|
|
567
567
|
const TEMPLATE_404_PAGE = `\
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@docsector/docsector-reader",
|
|
3
|
-
"version": "4.5.
|
|
3
|
+
"version": "4.5.6",
|
|
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",
|