Skip to content

Commit 940cd28

Browse files
R-BowerR-Bower
authored
Merge pull request #213 from qualcomm/perf/mdx-vite-caching
perf/mdx-vite-caching
2 parents f4e7a6e + f8f0df6 commit 940cd28

41 files changed

Lines changed: 949 additions & 211 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎packages/common/mdx-common/CHANGELOG.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,11 @@
11
# @qualcomm-ui/mdx-common Changelog
22

3+
## 2.1.0 (2026/03/28)
4+
5+
### Features
6+
7+
- [docs-plugin]: add raw frontmatter data field to PageSection type ([d4544cc](https://github.com/qualcomm/qualcomm-ui/commit/d4544cc))
8+
39
## 2.0.0 (2026/03/06)
410

511
### BREAKING CHANGES

‎packages/common/mdx-common/package.json‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@qualcomm-ui/mdx-common",
3-
"version": "2.0.0",
3+
"version": "2.1.0",
44
"description": "MDX common types and utilities",
55
"author": "Ryan Bower",
66
"license": "BSD-3-Clause-Clear",

‎packages/common/mdx-common/src/docs-plugin.types.ts‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -152,6 +152,12 @@ export interface PageSection extends PageFrontmatter {
152152
*/
153153
contentSections?: PageSectionContent[]
154154

155+
/**
156+
* Raw frontmatter for this page. Can be used to retrieve fields that aren't
157+
* documented.
158+
*/
159+
data: Record<string, unknown>
160+
155161
/**
156162
* Text content of the {@link content}'s closest heading.
157163
*/

‎packages/common/mdx-vite/CHANGELOG.md‎

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,33 @@
11
# @qualcomm-ui/mdx-vite Changelog
22

3+
## 3.1.0 (2026/03/28)
4+
5+
### Features
6+
7+
- [search-indexer]: populate frontmatter data field ([c6c9417](https://github.com/qualcomm/qualcomm-ui/commit/c6c9417))
8+
9+
### Code Refactoring
10+
11+
- [docs-layout]: separate page header from page actions ([58fc23e](https://github.com/qualcomm/qualcomm-ui/commit/58fc23e))
12+
- [remark-pipeline]: remove unused Processor type import ([4193ed0](https://github.com/qualcomm/qualcomm-ui/commit/4193ed0))
13+
- [knowledge-exporter]: improve type safety ([09f7a0e](https://github.com/qualcomm/qualcomm-ui/commit/09f7a0e))
14+
15+
### Performance Improvements
16+
17+
- [search-indexer]: skip rebuilding git metadata map when already populated ([e90a579](https://github.com/qualcomm/qualcomm-ui/commit/e90a579))
18+
- [knowledge-exporter]: use dirent.isDirectory() instead of separate stat call ([54a92d9](https://github.com/qualcomm/qualcomm-ui/commit/54a92d9))
19+
- [section-extractor]: hoist remark processors to module level ([127cfd7](https://github.com/qualcomm/qualcomm-ui/commit/127cfd7))
20+
- [knowledge-exporter]: add page-level caching ([fddcd20](https://github.com/qualcomm/qualcomm-ui/commit/fddcd20))
21+
- [knowledge-exporter]: hoist formatThemeNodes await outside processor creation ([ad16586](https://github.com/qualcomm/qualcomm-ui/commit/ad16586))
22+
23+
### Tests
24+
25+
- [search-indexer]: update fixture data for frontmatter data field ([05f8751](https://github.com/qualcomm/qualcomm-ui/commit/05f8751))
26+
27+
### Miscellaneous Chores
28+
29+
- **deps:** update dependencies [@qualcomm-ui/mdx-common]
30+
331
## 3.0.3 (2026/03/24)
432

533
- **deps:** update dependencies [@qualcomm-ui/tailwind-plugin]

‎packages/common/mdx-vite/package.json‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@qualcomm-ui/mdx-vite",
3-
"version": "3.0.3",
3+
"version": "3.1.0",
44
"description": "Vite documentation plugin for applications that use MDX",
55
"author": "Ryan Bower",
66
"license": "BSD-3-Clause-Clear",
@@ -90,7 +90,7 @@
9090
"devDependencies": {
9191
"@qualcomm-ui/cli": "catalog:",
9292
"@qualcomm-ui/esbuild": "catalog:",
93-
"@qualcomm-ui/mdx-common": "workspace:^2.0.0",
93+
"@qualcomm-ui/mdx-common": "workspace:^2.1.0",
9494
"@qualcomm-ui/utils": "workspace:^1.2.1",
9595
"@qualcomm-ui/tsconfig": "catalog:",
9696
"@qualcomm-ui/tailwind-plugin": "workspace:^1.7.0",
@@ -125,7 +125,7 @@
125125
"zod": "^4.1.13"
126126
},
127127
"peerDependencies": {
128-
"@qualcomm-ui/mdx-common": "workspace:^2.0.0",
128+
"@qualcomm-ui/mdx-common": "workspace:^2.1.0",
129129
"@qualcomm-ui/typedoc-common": "workspace:^1.0.3",
130130
"@qualcomm-ui/utils": "workspace:^1.2.1",
131131
"lodash-es": ">=4.17.21 <5",

‎packages/common/mdx-vite/src/docs-plugin/__tests__/fixtures/edge-cases/side-nav-title/mock-data/page-map.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
"Snapdragon Guardian",
55
"Snapdragon Guardian APIs"
66
],
7+
"data": {
8+
"title": "Snapdragon Guardian APIs",
9+
"sideNavTitle": "Reference"
10+
},
711
"id": "/routes/snapdragon-guardian+/try-it-out.mdx",
812
"pathname": "/snapdragon-guardian/try-it-out",
913
"pathSegments": [
@@ -17,6 +21,10 @@
1721
"Snapdragon Guardian",
1822
"Snapdragon Guardian API Guide"
1923
],
24+
"data": {
25+
"title": "Snapdragon Guardian API Guide",
26+
"sideNavTitle": "Getting Started"
27+
},
2028
"id": "/routes/snapdragon-guardian+/documentation.mdx",
2129
"pathname": "/snapdragon-guardian/documentation",
2230
"pathSegments": [

‎packages/common/mdx-vite/src/docs-plugin/__tests__/fixtures/edge-cases/side-nav-title/mock-data/search-index.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,10 @@
44
"Snapdragon Guardian",
55
"Snapdragon Guardian APIs"
66
],
7+
"data": {
8+
"title": "Snapdragon Guardian APIs",
9+
"sideNavTitle": "Reference"
10+
},
711
"id": "/routes/snapdragon-guardian+/try-it-out.mdx-0",
812
"pathname": "/snapdragon-guardian/try-it-out",
913
"pathSegments": [
@@ -21,6 +25,10 @@
2125
"Snapdragon Guardian",
2226
"Snapdragon Guardian API Guide"
2327
],
28+
"data": {
29+
"title": "Snapdragon Guardian API Guide",
30+
"sideNavTitle": "Getting Started"
31+
},
2432
"id": "/routes/snapdragon-guardian+/documentation.mdx",
2533
"pathname": "/snapdragon-guardian/documentation",
2634
"pathSegments": [

‎packages/common/mdx-vite/src/docs-plugin/__tests__/fixtures/react-router-hybrid-routes/mock-data/page-map.json‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33
"categories": [
44
"Introduction"
55
],
6+
"data": {
7+
"hideBreadcrumbs": true,
8+
"id": "_index",
9+
"title": "Introduction"
10+
},
611
"hideBreadcrumbs": true,
712
"id": "/routes/index.mdx",
813
"pathname": "/",
@@ -14,6 +19,9 @@
1419
"Test",
1520
"B Test"
1621
],
22+
"data": {
23+
"title": "B Test"
24+
},
1725
"id": "/routes/test+/b+/route.mdx",
1826
"pathname": "/test/b",
1927
"pathSegments": [
@@ -27,6 +35,9 @@
2735
"Test",
2836
"A Test"
2937
],
38+
"data": {
39+
"title": "A Test"
40+
},
3041
"id": "/routes/test+/a+/_a.mdx",
3142
"pathname": "/test/a",
3243
"pathSegments": [
@@ -40,6 +51,9 @@
4051
"Guide",
4152
"Page Setup"
4253
],
54+
"data": {
55+
"title": "Page Setup"
56+
},
4357
"id": "/routes/guide+/page-setup.mdx",
4458
"pathname": "/guide/page-setup",
4559
"pathSegments": [
@@ -133,6 +147,10 @@
133147
"Guide",
134148
"Markdown"
135149
],
150+
"data": {
151+
"title": "Markdown",
152+
"description": "Learn about how QUI Docs can enhance your Markdown authoring experience."
153+
},
136154
"description": "Learn about how QUI Docs can enhance your Markdown authoring experience.",
137155
"id": "/routes/guide+/markdown.mdx",
138156
"pathname": "/guide/markdown",
@@ -305,6 +323,10 @@
305323
"Guide",
306324
"AI Knowledge"
307325
],
326+
"data": {
327+
"title": "AI Knowledge",
328+
"description": "Generate structured JSON exports from documentation for LLM consumption and RAG pipelines."
329+
},
308330
"description": "Generate structured JSON exports from documentation for LLM consumption and RAG pipelines.",
309331
"id": "/routes/guide+/ai-knowledge.mdx",
310332
"pathname": "/guide/ai-knowledge",
@@ -447,6 +469,9 @@
447469
"Getting Started",
448470
"Sign Up"
449471
],
472+
"data": {
473+
"title": "Sign Up"
474+
},
450475
"id": "/routes/getting-started+/sign-up.mdx",
451476
"pathname": "/getting-started/sign-up",
452477
"pathSegments": [
@@ -460,6 +485,9 @@
460485
"Getting Started",
461486
"Log In"
462487
],
488+
"data": {
489+
"title": "Log In"
490+
},
463491
"id": "/routes/getting-started+/log-in.mdx",
464492
"pathname": "/getting-started/log-in",
465493
"pathSegments": [
@@ -472,6 +500,9 @@
472500
"categories": [
473501
"Getting Started"
474502
],
503+
"data": {
504+
"title": "Getting Started"
505+
},
475506
"id": "/routes/getting-started+/index.mdx",
476507
"pathname": "/getting-started",
477508
"pathSegments": [
@@ -484,6 +515,9 @@
484515
"Getting Started",
485516
"Home"
486517
],
518+
"data": {
519+
"title": "Home"
520+
},
487521
"id": "/routes/getting-started+/home.mdx",
488522
"pathname": "/getting-started/home",
489523
"pathSegments": [
@@ -497,6 +531,9 @@
497531
"Getting Started",
498532
"Dedicated Devices"
499533
],
534+
"data": {
535+
"title": "Dedicated Devices"
536+
},
500537
"id": "/routes/getting-started+/dedicated-devices.mdx",
501538
"pathname": "/getting-started/dedicated-devices",
502539
"pathSegments": [
@@ -510,6 +547,9 @@
510547
"Best Practices",
511548
"Choosing Dependencies"
512549
],
550+
"data": {
551+
"title": "Choosing Dependencies"
552+
},
513553
"id": "/routes/best-practices+/choosing-dependencies.mdx",
514554
"pathname": "/best-practices/choosing-dependencies",
515555
"pathSegments": [

0 commit comments

Comments
 (0)