@qualcomm-ui/mdx-vite 2.17.2 → 3.0.1
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/dist/cli.js +1881 -3540
- package/dist/cli.js.map +4 -4
- package/dist/docs-plugin/{internal → config}/config-loader.d.ts +1 -9
- package/dist/docs-plugin/config/config-loader.d.ts.map +1 -0
- package/dist/docs-plugin/config/config-schema.d.ts +50 -0
- package/dist/docs-plugin/config/config-schema.d.ts.map +1 -0
- package/dist/docs-plugin/config/index.d.ts +4 -0
- package/dist/docs-plugin/config/index.d.ts.map +1 -0
- package/dist/docs-plugin/config/types.d.ts +266 -0
- package/dist/docs-plugin/config/types.d.ts.map +1 -0
- package/dist/docs-plugin/config/zod.d.ts.map +1 -0
- package/dist/docs-plugin/{internal/services/doc-props → doc-props}/doc-props-indexer.d.ts +1 -1
- package/dist/docs-plugin/doc-props/doc-props-indexer.d.ts.map +1 -0
- package/dist/docs-plugin/doc-props/index.d.ts.map +1 -0
- package/dist/docs-plugin/docs-plugin.d.ts.map +1 -1
- package/dist/docs-plugin/generate-page-map.d.ts.map +1 -1
- package/dist/docs-plugin/index.d.ts +2 -1
- package/dist/docs-plugin/index.d.ts.map +1 -1
- package/dist/docs-plugin/markdown/create-slug.d.ts +16 -0
- package/dist/docs-plugin/markdown/create-slug.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/frontmatter-schema.d.ts +7 -0
- package/dist/docs-plugin/markdown/frontmatter-schema.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/index.d.ts +6 -0
- package/dist/docs-plugin/markdown/index.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/knowledge/filter-frontmatter.d.ts +3 -0
- package/dist/docs-plugin/markdown/knowledge/filter-frontmatter.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/knowledge/index.d.ts +2 -0
- package/dist/docs-plugin/markdown/knowledge/index.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/knowledge/knowledge-exporter.d.ts +36 -0
- package/dist/docs-plugin/markdown/knowledge/knowledge-exporter.d.ts.map +1 -0
- package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/demo-plugin.d.ts +1 -1
- package/dist/docs-plugin/markdown/knowledge/plugins/demo-plugin.d.ts.map +1 -0
- package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/doc-props-plugin.d.ts +11 -1
- package/dist/docs-plugin/markdown/knowledge/plugins/doc-props-plugin.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/knowledge/plugins/filter-text-directives.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/knowledge/plugins/index.d.ts +6 -0
- package/dist/docs-plugin/markdown/knowledge/plugins/index.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/knowledge/plugins/npm-install-tabs-plugin.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/knowledge/plugins/qds-theme-plugin.d.ts.map +1 -0
- package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge}/section-extractor.d.ts +17 -4
- package/dist/docs-plugin/markdown/knowledge/section-extractor.d.ts.map +1 -0
- package/dist/{ai-knowledge/generator/generator.types.d.ts → docs-plugin/markdown/knowledge/types.d.ts} +2 -10
- package/dist/docs-plugin/markdown/knowledge/types.d.ts.map +1 -0
- package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge}/utils.d.ts +2 -2
- package/dist/docs-plugin/markdown/knowledge/utils.d.ts.map +1 -0
- package/dist/docs-plugin/{internal/services/markdown → markdown}/markdown-file-reader.d.ts +9 -3
- package/dist/docs-plugin/markdown/markdown-file-reader.d.ts.map +1 -0
- package/dist/docs-plugin/{internal/services/markdown → markdown}/markdown.types.d.ts +5 -3
- package/dist/docs-plugin/markdown/markdown.types.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/mdx-utils.d.ts.map +1 -0
- package/dist/docs-plugin/markdown/remark-pipeline.d.ts +36 -0
- package/dist/docs-plugin/markdown/remark-pipeline.d.ts.map +1 -0
- package/dist/docs-plugin/mdx-plugins.d.ts +1 -9
- package/dist/docs-plugin/mdx-plugins.d.ts.map +1 -1
- package/dist/docs-plugin/{internal/services/nav-builder → nav-builder}/get-route-meta.d.ts +1 -1
- package/dist/docs-plugin/nav-builder/get-route-meta.d.ts.map +1 -0
- package/dist/docs-plugin/nav-builder/index.d.ts +6 -0
- package/dist/docs-plugin/nav-builder/index.d.ts.map +1 -0
- package/dist/docs-plugin/{internal/services/nav-builder → nav-builder}/nav-builder.d.ts +1 -1
- package/dist/docs-plugin/nav-builder/nav-builder.d.ts.map +1 -0
- package/dist/docs-plugin/{internal/services/nav-builder → nav-builder}/page-map.d.ts +2 -1
- package/dist/docs-plugin/nav-builder/page-map.d.ts.map +1 -0
- package/dist/docs-plugin/nav-builder/transform-route-meta-array.d.ts +3 -0
- package/dist/docs-plugin/nav-builder/transform-route-meta-array.d.ts.map +1 -0
- package/dist/docs-plugin/nav-builder/types.d.ts +86 -0
- package/dist/docs-plugin/nav-builder/types.d.ts.map +1 -0
- package/dist/docs-plugin/path-utils.d.ts +9 -0
- package/dist/docs-plugin/path-utils.d.ts.map +1 -0
- package/dist/docs-plugin/plugin-state.d.ts +57 -0
- package/dist/docs-plugin/plugin-state.d.ts.map +1 -0
- package/dist/docs-plugin/rehype/rehype-slug.d.ts.map +1 -1
- package/dist/docs-plugin/remark/index.d.ts +3 -0
- package/dist/docs-plugin/remark/index.d.ts.map +1 -1
- package/dist/docs-plugin/remark/remark-remove-code-blocks.d.ts.map +1 -0
- package/dist/docs-plugin/remark/remark-remove-jsx.d.ts.map +1 -0
- package/dist/docs-plugin/remark/remark-steps.d.ts.map +1 -1
- package/dist/docs-plugin/{internal/search-indexer.d.ts → search-indexer.d.ts} +13 -9
- package/dist/docs-plugin/search-indexer.d.ts.map +1 -0
- package/dist/docs-plugin/virtual.d.ts +39 -0
- package/dist/index.js +3709 -7382
- package/dist/index.js.map +4 -4
- package/dist/open-web-ui/api.d.ts.map +1 -0
- package/dist/{ai-knowledge/open-web-ui → open-web-ui}/common.d.ts +4 -12
- package/dist/open-web-ui/common.d.ts.map +1 -0
- package/dist/open-web-ui/download-knowledge.d.ts.map +1 -0
- package/dist/open-web-ui/env.d.ts +11 -0
- package/dist/open-web-ui/env.d.ts.map +1 -0
- package/dist/{ai-knowledge/open-web-ui → open-web-ui}/knowledge-cleaner.d.ts +5 -1
- package/dist/open-web-ui/knowledge-cleaner.d.ts.map +1 -0
- package/dist/open-web-ui/upload-knowledge.d.ts.map +1 -0
- package/dist/react-demo-plugin/index.d.ts +0 -1
- package/dist/react-demo-plugin/index.d.ts.map +1 -1
- package/dist/tsbuildinfo +1 -1
- package/package.json +4 -5
- package/dist/ai-knowledge/env.d.ts +0 -27
- package/dist/ai-knowledge/env.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/command.d.ts +0 -9
- package/dist/ai-knowledge/generator/command.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/config.d.ts +0 -4
- package/dist/ai-knowledge/generator/config.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/demo-plugin.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/doc-props-plugin.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/filter-text-directives.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/generator.types.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/index.d.ts +0 -2
- package/dist/ai-knowledge/generator/index.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/knowledge-generator.d.ts +0 -35
- package/dist/ai-knowledge/generator/knowledge-generator.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/npm-install-tabs-plugin.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/qds-theme-plugin.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/section-extractor.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/section.types.d.ts +0 -96
- package/dist/ai-knowledge/generator/section.types.d.ts.map +0 -1
- package/dist/ai-knowledge/generator/utils.d.ts.map +0 -1
- package/dist/ai-knowledge/open-web-ui/api.d.ts.map +0 -1
- package/dist/ai-knowledge/open-web-ui/common.d.ts.map +0 -1
- package/dist/ai-knowledge/open-web-ui/download-knowledge.d.ts.map +0 -1
- package/dist/ai-knowledge/open-web-ui/knowledge-cleaner.d.ts.map +0 -1
- package/dist/ai-knowledge/open-web-ui/upload-knowledge.d.ts.map +0 -1
- package/dist/ai-knowledge/types.d.ts +0 -57
- package/dist/ai-knowledge/types.d.ts.map +0 -1
- package/dist/docs-plugin/internal/config-loader.d.ts.map +0 -1
- package/dist/docs-plugin/internal/config-schema.d.ts +0 -124
- package/dist/docs-plugin/internal/config-schema.d.ts.map +0 -1
- package/dist/docs-plugin/internal/index.d.ts +0 -8
- package/dist/docs-plugin/internal/index.d.ts.map +0 -1
- package/dist/docs-plugin/internal/search-indexer.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/doc-props/doc-props-indexer.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/doc-props/index.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/index.d.ts +0 -4
- package/dist/docs-plugin/internal/services/index.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/markdown/index.d.ts +0 -6
- package/dist/docs-plugin/internal/services/markdown/index.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/markdown/markdown-file-reader.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/markdown/markdown-indexer.d.ts +0 -27
- package/dist/docs-plugin/internal/services/markdown/markdown-indexer.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/markdown/markdown.types.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/markdown/remark-remove-code-blocks.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/markdown/remark-remove-jsx.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/mdx-utils.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/nav-builder/get-route-meta.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/nav-builder/index.d.ts +0 -4
- package/dist/docs-plugin/internal/services/nav-builder/index.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/nav-builder/nav-builder.d.ts.map +0 -1
- package/dist/docs-plugin/internal/services/nav-builder/page-map.d.ts.map +0 -1
- package/dist/docs-plugin/internal/transform-route-meta-array.d.ts +0 -3
- package/dist/docs-plugin/internal/transform-route-meta-array.d.ts.map +0 -1
- package/dist/docs-plugin/internal/utils.d.ts +0 -17
- package/dist/docs-plugin/internal/utils.d.ts.map +0 -1
- package/dist/docs-plugin/internal/zod.d.ts.map +0 -1
- package/dist/docs-plugin/shiki/internal/tests/shiki-transformer-tailwind.spec.d.ts +0 -2
- package/dist/docs-plugin/shiki/internal/tests/shiki-transformer-tailwind.spec.d.ts.map +0 -1
- package/dist/docs-plugin/types.d.ts +0 -428
- package/dist/docs-plugin/types.d.ts.map +0 -1
- package/dist/react-demo-plugin/generate-lazy-demo-map.d.ts +0 -21
- package/dist/react-demo-plugin/generate-lazy-demo-map.d.ts.map +0 -1
- /package/dist/docs-plugin/{internal → config}/zod.d.ts +0 -0
- /package/dist/docs-plugin/{internal/services/doc-props → doc-props}/index.d.ts +0 -0
- /package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/filter-text-directives.d.ts +0 -0
- /package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/npm-install-tabs-plugin.d.ts +0 -0
- /package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/qds-theme-plugin.d.ts +0 -0
- /package/dist/docs-plugin/{internal/services → markdown}/mdx-utils.d.ts +0 -0
- /package/dist/docs-plugin/{internal/services/markdown → remark}/remark-remove-code-blocks.d.ts +0 -0
- /package/dist/docs-plugin/{internal/services/markdown → remark}/remark-remove-jsx.d.ts +0 -0
- /package/dist/{ai-knowledge/open-web-ui → open-web-ui}/api.d.ts +0 -0
- /package/dist/{ai-knowledge/open-web-ui → open-web-ui}/download-knowledge.d.ts +0 -0
- /package/dist/{ai-knowledge/open-web-ui → open-web-ui}/upload-knowledge.d.ts +0 -0
|
@@ -1,12 +1,4 @@
|
|
|
1
|
-
import type {
|
|
2
|
-
export interface ResolvedQuiDocsConfig extends QuiDocsConfig {
|
|
3
|
-
appDirectory: string;
|
|
4
|
-
/**
|
|
5
|
-
* full path to the cosmiconfig file.
|
|
6
|
-
*/
|
|
7
|
-
filePath: string;
|
|
8
|
-
pageDirectory: string;
|
|
9
|
-
}
|
|
1
|
+
import type { ResolvedQuiDocsConfig } from "./types";
|
|
10
2
|
export interface ConfigLoaderOptions {
|
|
11
3
|
/**
|
|
12
4
|
* Path to the qui-docs config file. This is automatically detected if omitted.
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-loader.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/config/config-loader.ts"],"names":[],"mappings":"AAQA,OAAO,KAAK,EAAC,qBAAqB,EAAC,MAAM,SAAS,CAAA;AAQlD,MAAM,WAAW,mBAAmB;IAClC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED,qBAAa,YAAY;IACvB,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAqB;gBAEjC,OAAO,EAAE,mBAAmB;IAKxC,OAAO,CAAC,cAAc;IAgBtB,OAAO,CAAC,4BAA4B;IAmBpC,UAAU,IAAI,qBAAqB;CAIpC"}
|
|
@@ -0,0 +1,50 @@
|
|
|
1
|
+
import { z, type ZodObject, type ZodSchema } from "zod";
|
|
2
|
+
import type { RouteMeta } from "../nav-builder/types";
|
|
3
|
+
export declare const navMetaSchema: ZodObject<{}>;
|
|
4
|
+
export declare const routeMetaSchema: ZodSchema<RouteMeta>;
|
|
5
|
+
export declare const configSchema: z.ZodObject<{
|
|
6
|
+
appDirectory: z.ZodOptional<z.ZodString>;
|
|
7
|
+
disableCache: z.ZodOptional<z.ZodBoolean>;
|
|
8
|
+
headings: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodLiteral<"h1">, z.ZodLiteral<"h2">, z.ZodLiteral<"h3">, z.ZodLiteral<"h4">, z.ZodLiteral<"h5">, z.ZodLiteral<"h6">]>>>;
|
|
9
|
+
hotUpdateIgnore: z.ZodOptional<z.ZodCustom<RegExp, RegExp>>;
|
|
10
|
+
knowledge: z.ZodOptional<z.ZodObject<{
|
|
11
|
+
baseUrl: z.ZodOptional<z.ZodString>;
|
|
12
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
13
|
+
extraFiles: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
14
|
+
contents: z.ZodString;
|
|
15
|
+
id: z.ZodString;
|
|
16
|
+
processAsMdx: z.ZodOptional<z.ZodBoolean>;
|
|
17
|
+
title: z.ZodOptional<z.ZodString>;
|
|
18
|
+
}, z.core.$strip>>>;
|
|
19
|
+
frontmatter: z.ZodOptional<z.ZodObject<{
|
|
20
|
+
exclude: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
21
|
+
include: z.ZodOptional<z.ZodArray<z.ZodString>>;
|
|
22
|
+
}, z.core.$strip>>;
|
|
23
|
+
integrations: z.ZodOptional<z.ZodObject<{
|
|
24
|
+
openWebUi: z.ZodOptional<z.ZodArray<z.ZodObject<{
|
|
25
|
+
envFile: z.ZodOptional<z.ZodString>;
|
|
26
|
+
id: z.ZodString;
|
|
27
|
+
}, z.core.$strip>>>;
|
|
28
|
+
}, z.core.$strip>>;
|
|
29
|
+
outputPath: z.ZodOptional<z.ZodString>;
|
|
30
|
+
pageIdPrefix: z.ZodOptional<z.ZodString>;
|
|
31
|
+
pages: z.ZodOptional<z.ZodObject<{
|
|
32
|
+
outputPath: z.ZodOptional<z.ZodString>;
|
|
33
|
+
}, z.core.$strip>>;
|
|
34
|
+
sections: z.ZodOptional<z.ZodObject<{
|
|
35
|
+
depths: z.ZodOptional<z.ZodArray<z.ZodNumber>>;
|
|
36
|
+
minContentLength: z.ZodOptional<z.ZodNumber>;
|
|
37
|
+
outputPath: z.ZodOptional<z.ZodString>;
|
|
38
|
+
}, z.core.$strip>>;
|
|
39
|
+
}, z.core.$strip>>;
|
|
40
|
+
navConfig: z.ZodOptional<z.ZodArray<z.ZodUnion<readonly [z.ZodType<RouteMeta, unknown, z.core.$ZodTypeInternals<RouteMeta, unknown>>, z.ZodObject<{}, z.core.$strip>]>>>;
|
|
41
|
+
pageDirectory: z.ZodOptional<z.ZodString>;
|
|
42
|
+
pageTimestampMetadata: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"off">, z.ZodLiteral<"timestamp">, z.ZodLiteral<"user-and-timestamp">]>>;
|
|
43
|
+
routingStrategy: z.ZodOptional<z.ZodUnion<readonly [z.ZodLiteral<"vite-generouted">, z.ZodAny]>>;
|
|
44
|
+
throwOnError: z.ZodOptional<z.ZodBoolean>;
|
|
45
|
+
typeDocProps: z.ZodOptional<z.ZodString>;
|
|
46
|
+
typeDocPropsOptions: z.ZodOptional<z.ZodObject<{
|
|
47
|
+
includeInSearchIndex: z.ZodOptional<z.ZodBoolean>;
|
|
48
|
+
}, z.core.$strip>>;
|
|
49
|
+
}, z.core.$strip>;
|
|
50
|
+
//# sourceMappingURL=config-schema.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"config-schema.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/config/config-schema.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,CAAC,EAAE,KAAK,SAAS,EAAE,KAAK,SAAS,EAAC,MAAM,KAAK,CAAA;AAErD,OAAO,KAAK,EAAU,SAAS,EAAC,MAAM,sBAAsB,CAAA;AAa5D,eAAO,MAAM,aAAa,EAAE,SAAS,CAAC,EAAE,CAItC,CAAA;AAEF,eAAO,MAAM,eAAe,EAAE,SAAS,CAAC,SAAS,CAmB7C,CAAA;AAmDJ,eAAO,MAAM,YAAY;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;iBA8BvB,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/config/index.ts"],"names":[],"mappings":"AAAA,cAAc,iBAAiB,CAAA;AAC/B,cAAc,iBAAiB,CAAA;AAC/B,cAAc,SAAS,CAAA"}
|
|
@@ -0,0 +1,266 @@
|
|
|
1
|
+
import type { TocHeading } from "@qualcomm-ui/mdx-common";
|
|
2
|
+
import type { QuiPropTypes } from "@qualcomm-ui/typedoc-common";
|
|
3
|
+
import type { NavConfig } from "../nav-builder/types";
|
|
4
|
+
export type RoutingStrategy = "vite-generouted" | ((filePath: string) => string[]);
|
|
5
|
+
export interface KnowledgeFrontmatterConfig {
|
|
6
|
+
/**
|
|
7
|
+
* Glob patterns for frontmatter fields to exclude (applied after include).
|
|
8
|
+
*/
|
|
9
|
+
exclude?: string[];
|
|
10
|
+
/**
|
|
11
|
+
* Glob patterns for frontmatter fields to include in output.
|
|
12
|
+
* Use ["*"] to include all fields.
|
|
13
|
+
*/
|
|
14
|
+
include?: string[];
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Controls how page timestamp metadata is populated from git history.
|
|
18
|
+
* - "off": No timestamp data is added
|
|
19
|
+
* - "timestamp": Only `updatedOn` is populated
|
|
20
|
+
* - "user-and-timestamp": Both `updatedOn` and `updatedBy` are populated
|
|
21
|
+
*/
|
|
22
|
+
export type PageTimestampMetadataMode = "off" | "timestamp" | "user-and-timestamp";
|
|
23
|
+
export interface QuiDocsTypeDocOptions {
|
|
24
|
+
/**
|
|
25
|
+
* Whether to include each page's TypeDocProps property documentation in the
|
|
26
|
+
* search index. If this is true, the property documentation for each occurrence
|
|
27
|
+
* of `<TypeDocProps />` will be built into the search index.
|
|
28
|
+
*/
|
|
29
|
+
includeInSearchIndex?: boolean | undefined;
|
|
30
|
+
}
|
|
31
|
+
/**
|
|
32
|
+
* OpenWebUI integration configuration.
|
|
33
|
+
*/
|
|
34
|
+
export interface OpenWebUiIntegration {
|
|
35
|
+
/**
|
|
36
|
+
* Path to env file containing `OPEN_WEB_UI_*` variables. Defaults to
|
|
37
|
+
* `.env.{id}` by convention.
|
|
38
|
+
*/
|
|
39
|
+
envFile?: string;
|
|
40
|
+
/**
|
|
41
|
+
* Unique identifier for this integration.
|
|
42
|
+
*/
|
|
43
|
+
id: string;
|
|
44
|
+
}
|
|
45
|
+
/**
|
|
46
|
+
* Extra content to include in knowledge output. Assumed to be Markdown.
|
|
47
|
+
*/
|
|
48
|
+
export interface KnowledgeExtraFile {
|
|
49
|
+
/**
|
|
50
|
+
* The Markdown content for this file.
|
|
51
|
+
*/
|
|
52
|
+
contents: string;
|
|
53
|
+
/**
|
|
54
|
+
* Unique identifier for this file, used for the output filename.
|
|
55
|
+
*/
|
|
56
|
+
id: string;
|
|
57
|
+
/**
|
|
58
|
+
* Whether to process this file as MDX content, replacing relative URLs, and
|
|
59
|
+
* applying other transformations as if the file were authored as mdx
|
|
60
|
+
* documentation.
|
|
61
|
+
*/
|
|
62
|
+
processAsMdx?: boolean;
|
|
63
|
+
/**
|
|
64
|
+
* Display title for this content.
|
|
65
|
+
*/
|
|
66
|
+
title?: string;
|
|
67
|
+
}
|
|
68
|
+
/**
|
|
69
|
+
* Knowledge generation configuration for LLM integrations.
|
|
70
|
+
* Presence of this config enables knowledge generation.
|
|
71
|
+
*/
|
|
72
|
+
export interface KnowledgeConfig {
|
|
73
|
+
/**
|
|
74
|
+
* Base URL for documentation links in the generated output.
|
|
75
|
+
*/
|
|
76
|
+
baseUrl?: string;
|
|
77
|
+
/**
|
|
78
|
+
* Glob patterns to exclude, relative to the resolved page directory. Supports
|
|
79
|
+
* full glob syntax via minimatch.
|
|
80
|
+
*
|
|
81
|
+
* @example
|
|
82
|
+
* ```ts
|
|
83
|
+
* exclude: ['**\/internal/**', 'guide/drafts/*', '*.draft.mdx']
|
|
84
|
+
* ```
|
|
85
|
+
*/
|
|
86
|
+
exclude?: string[];
|
|
87
|
+
/**
|
|
88
|
+
* Extra files to include in knowledge output beyond the generated page content.
|
|
89
|
+
*
|
|
90
|
+
* @inheritDoc
|
|
91
|
+
*/
|
|
92
|
+
extraFiles?: KnowledgeExtraFile[];
|
|
93
|
+
/**
|
|
94
|
+
* Configuration for which frontmatter fields to include in the generated
|
|
95
|
+
* Markdown output. Uses glob patterns for flexible field selection.
|
|
96
|
+
*
|
|
97
|
+
* @inheritDoc
|
|
98
|
+
*/
|
|
99
|
+
frontmatter?: KnowledgeFrontmatterConfig;
|
|
100
|
+
/**
|
|
101
|
+
* Platform-specific integration configurations for uploading generated
|
|
102
|
+
* knowledge to external services.
|
|
103
|
+
*/
|
|
104
|
+
integrations?: {
|
|
105
|
+
/**
|
|
106
|
+
* @inheritDoc
|
|
107
|
+
*/
|
|
108
|
+
openWebUi?: OpenWebUiIntegration[];
|
|
109
|
+
};
|
|
110
|
+
/**
|
|
111
|
+
* Output directory for generated knowledge files, relative to the public dir.
|
|
112
|
+
*
|
|
113
|
+
* @default 'exports'
|
|
114
|
+
*/
|
|
115
|
+
outputPath?: string;
|
|
116
|
+
/**
|
|
117
|
+
* Prefix to use for page IDs. Used to generate unique page IDs for knowledgebases
|
|
118
|
+
* that span multiple QUI Docs sites with potentially overlapping routes.
|
|
119
|
+
*
|
|
120
|
+
* @example `table-`
|
|
121
|
+
*/
|
|
122
|
+
pageIdPrefix?: string;
|
|
123
|
+
/**
|
|
124
|
+
* Configuration for whole-page JSON exports.
|
|
125
|
+
*
|
|
126
|
+
* @inheritDoc
|
|
127
|
+
*/
|
|
128
|
+
pages?: PagesExportConfig;
|
|
129
|
+
/**
|
|
130
|
+
* Configuration for header-scoped section exports.
|
|
131
|
+
*
|
|
132
|
+
* @inheritDoc
|
|
133
|
+
*/
|
|
134
|
+
sections?: SectionExportConfig;
|
|
135
|
+
}
|
|
136
|
+
export interface SearchIndexerOptions {
|
|
137
|
+
/**
|
|
138
|
+
* Disable the file cache. This cache stores the result of parsed MDX files based
|
|
139
|
+
* on each file's md5 checksum. On subsequent edits, values are retrieved from the
|
|
140
|
+
* cache and parsing is avoided for files that have not changed.
|
|
141
|
+
*/
|
|
142
|
+
disableCache?: boolean;
|
|
143
|
+
/**
|
|
144
|
+
* ToC headings.
|
|
145
|
+
*
|
|
146
|
+
* @default ['h2','h3','h4']
|
|
147
|
+
*/
|
|
148
|
+
headings?: TocHeading[];
|
|
149
|
+
/**
|
|
150
|
+
* Optional property for defining nav item hierarchy and page metadata.
|
|
151
|
+
*
|
|
152
|
+
* @inheritDoc
|
|
153
|
+
*/
|
|
154
|
+
navConfig?: NavConfig[];
|
|
155
|
+
/**
|
|
156
|
+
* Name of the directory where the MDX pages are located. NOT the full path to the
|
|
157
|
+
* directory.
|
|
158
|
+
*/
|
|
159
|
+
pageDirectory: string;
|
|
160
|
+
/**
|
|
161
|
+
* Controls how page timestamp metadata is populated from git history.
|
|
162
|
+
*
|
|
163
|
+
* @default "off"
|
|
164
|
+
*/
|
|
165
|
+
pageTimestampMetadata?: PageTimestampMetadataMode;
|
|
166
|
+
/**
|
|
167
|
+
* Strategy to use for building each route's path segments. Omit this property if
|
|
168
|
+
* you are using the default {@link https://github.com/kiliman/remix-flat-routes
|
|
169
|
+
* remix-flat-routes} configuration.
|
|
170
|
+
*/
|
|
171
|
+
routingStrategy?: RoutingStrategy;
|
|
172
|
+
/**
|
|
173
|
+
* Resolved path to the React Router app directory.
|
|
174
|
+
*/
|
|
175
|
+
srcDir: string;
|
|
176
|
+
/**
|
|
177
|
+
* Whether to throw an error if any issues occur during MDX processing.
|
|
178
|
+
*
|
|
179
|
+
* @default false
|
|
180
|
+
*/
|
|
181
|
+
throwOnError?: boolean;
|
|
182
|
+
/**
|
|
183
|
+
* Resolved QUI TypeDoc props.
|
|
184
|
+
*/
|
|
185
|
+
typeDocProps?: Record<string, QuiPropTypes>;
|
|
186
|
+
/**
|
|
187
|
+
* Options for TypeDoc property documentation.
|
|
188
|
+
*/
|
|
189
|
+
typeDocPropsOptions?: QuiDocsTypeDocOptions;
|
|
190
|
+
}
|
|
191
|
+
export interface QuiDocsConfig extends Omit<SearchIndexerOptions, "srcDir" | "pageDirectory" | "typeDocProps"> {
|
|
192
|
+
/**
|
|
193
|
+
* Root app directory. NOT the full path to the directory.
|
|
194
|
+
*
|
|
195
|
+
* @default 'app'
|
|
196
|
+
*/
|
|
197
|
+
appDirectory?: string;
|
|
198
|
+
/**
|
|
199
|
+
* Matched files will not trigger a rebuild on hot update.
|
|
200
|
+
*/
|
|
201
|
+
hotUpdateIgnore?: RegExp;
|
|
202
|
+
/**
|
|
203
|
+
* Knowledge generation configuration for LLM integrations.
|
|
204
|
+
*
|
|
205
|
+
* @inheritDoc
|
|
206
|
+
*/
|
|
207
|
+
knowledge?: KnowledgeConfig;
|
|
208
|
+
/**
|
|
209
|
+
* Name of the directory where the MDX pages are located. NOT the full path to the
|
|
210
|
+
* directory. This is relative to the {@link appDirectory}.
|
|
211
|
+
*
|
|
212
|
+
* @default 'routes'
|
|
213
|
+
*/
|
|
214
|
+
pageDirectory?: string;
|
|
215
|
+
/**
|
|
216
|
+
* Relative path to the typeDocProps json file. If the `<TypeDocProps />`
|
|
217
|
+
* component is used in an mdx page, the data for its referenced entity will be
|
|
218
|
+
* made available for property documentation rendering.
|
|
219
|
+
*
|
|
220
|
+
* Refer to the {@link https://docs.qui.qualcomm.com/guide/typedoc QUI typedoc guide} to learn more.
|
|
221
|
+
*/
|
|
222
|
+
typeDocProps?: string;
|
|
223
|
+
/**
|
|
224
|
+
* Options for TypeDoc property documentation.
|
|
225
|
+
*/
|
|
226
|
+
typeDocPropsOptions?: QuiDocsTypeDocOptions;
|
|
227
|
+
}
|
|
228
|
+
export interface ResolvedQuiDocsConfig extends QuiDocsConfig {
|
|
229
|
+
appDirectory: string;
|
|
230
|
+
/**
|
|
231
|
+
* full path to the cosmiconfig file.
|
|
232
|
+
*/
|
|
233
|
+
filePath: string;
|
|
234
|
+
pageDirectory: string;
|
|
235
|
+
}
|
|
236
|
+
/**
|
|
237
|
+
* Configuration for whole-page exports.
|
|
238
|
+
*/
|
|
239
|
+
export interface PagesExportConfig {
|
|
240
|
+
/**
|
|
241
|
+
* Output path for pages.json, relative to the public directory.
|
|
242
|
+
* @default 'pages.json'
|
|
243
|
+
*/
|
|
244
|
+
outputPath?: string;
|
|
245
|
+
}
|
|
246
|
+
/**
|
|
247
|
+
* Configuration for header-scoped section exports.
|
|
248
|
+
*/
|
|
249
|
+
export interface SectionExportConfig {
|
|
250
|
+
/**
|
|
251
|
+
* Header depths that define section boundaries.
|
|
252
|
+
* @default [1, 2, 3]
|
|
253
|
+
*/
|
|
254
|
+
depths?: number[];
|
|
255
|
+
/**
|
|
256
|
+
* Minimum content length to create a section entry.
|
|
257
|
+
* @default 0
|
|
258
|
+
*/
|
|
259
|
+
minContentLength?: number;
|
|
260
|
+
/**
|
|
261
|
+
* Output path for sections.json, relative to the public directory.
|
|
262
|
+
* @default 'sections.json'
|
|
263
|
+
*/
|
|
264
|
+
outputPath?: string;
|
|
265
|
+
}
|
|
266
|
+
//# sourceMappingURL=types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/config/types.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAC,UAAU,EAAC,MAAM,yBAAyB,CAAA;AACvD,OAAO,KAAK,EAAC,YAAY,EAAC,MAAM,6BAA6B,CAAA;AAE7D,OAAO,KAAK,EAAC,SAAS,EAAC,MAAM,sBAAsB,CAAA;AAEnD,MAAM,MAAM,eAAe,GACvB,iBAAiB,GACjB,CAAC,CAAC,QAAQ,EAAE,MAAM,KAAK,MAAM,EAAE,CAAC,CAAA;AAEpC,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;CACnB;AAED;;;;;GAKG;AACH,MAAM,MAAM,yBAAyB,GACjC,KAAK,GACL,WAAW,GACX,oBAAoB,CAAA;AAExB,MAAM,WAAW,qBAAqB;IACpC;;;;OAIG;IACH,oBAAoB,CAAC,EAAE,OAAO,GAAG,SAAS,CAAA;CAC3C;AAED;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;;OAGG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAEhB;;OAEG;IACH,EAAE,EAAE,MAAM,CAAA;IAEV;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAA;IAEhB;;;;;;;;OAQG;IACH,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAElB;;;;OAIG;IACH,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAA;IAEjC;;;;;OAKG;IACH,WAAW,CAAC,EAAE,0BAA0B,CAAA;IAExC;;;OAGG;IACH,YAAY,CAAC,EAAE;QACb;;WAEG;QACH,SAAS,CAAC,EAAE,oBAAoB,EAAE,CAAA;KACnC,CAAA;IAED;;;;OAIG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;;OAKG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,KAAK,CAAC,EAAE,iBAAiB,CAAA;IAEzB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,mBAAmB,CAAA;CAC/B;AAED,MAAM,WAAW,oBAAoB;IACnC;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;;;OAIG;IACH,QAAQ,CAAC,EAAE,UAAU,EAAE,CAAA;IAEvB;;;;OAIG;IACH,SAAS,CAAC,EAAE,SAAS,EAAE,CAAA;IAEvB;;;OAGG;IACH,aAAa,EAAE,MAAM,CAAA;IAErB;;;;OAIG;IACH,qBAAqB,CAAC,EAAE,yBAAyB,CAAA;IAEjD;;;;OAIG;IACH,eAAe,CAAC,EAAE,eAAe,CAAA;IAEjC;;OAEG;IACH,MAAM,EAAE,MAAM,CAAA;IAEd;;;;OAIG;IACH,YAAY,CAAC,EAAE,OAAO,CAAA;IAEtB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC,CAAA;IAE3C;;OAEG;IACH,mBAAmB,CAAC,EAAE,qBAAqB,CAAA;CAC5C;AAED,MAAM,WAAW,aACf,SAAQ,IAAI,CACV,oBAAoB,EACpB,QAAQ,GAAG,eAAe,GAAG,cAAc,CAC5C;IACD;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,eAAe,CAAC,EAAE,MAAM,CAAA;IAExB;;;;OAIG;IACH,SAAS,CAAC,EAAE,eAAe,CAAA;IAE3B;;;;;OAKG;IACH,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB;;;;;;OAMG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;IAErB;;OAEG;IACH,mBAAmB,CAAC,EAAE,qBAAqB,CAAA;CAC5C;AAED,MAAM,WAAW,qBAAsB,SAAQ,aAAa;IAC1D,YAAY,EAAE,MAAM,CAAA;IACpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,EAAE,MAAM,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;;OAGG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"zod.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/config/zod.ts"],"names":[],"mappings":"AAGA,OAAO,EAAC,CAAC,EAAC,MAAM,KAAK,CAAA;AAErB,KAAK,UAAU,CAAC,KAAK,IAAI;KACtB,GAAG,IAAI,MAAM,KAAK,CAAC,CAAC,GAAG,SAAS,SAAS,KAAK,CAAC,GAAG,CAAC,GAChD,IAAI,SAAS,KAAK,CAAC,GAAG,CAAC,GACrB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,CAAC,GACnD,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GACtC,IAAI,SAAS,KAAK,CAAC,GAAG,CAAC,GACrB,CAAC,CAAC,WAAW,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC,GACpC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,GAAG,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;CAClE,CAAA;AAED,wBAAgB,SAAS,CAAC,KAAK,GAAG,KAAK;WAGjC,MAAM,SAAS,UAAU,CAAC,KAAK,CAAC,GAAG,GAChC,UAAU,IAAI,OAAO,CAAC,MAAM,MAAM,EAAE,MAAM,KAAK,CAAC,GAAG,KAAK,GAC1D,UAEO,MAAM;EAGnB"}
|
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
import { type Plugin } from "unified";
|
|
2
2
|
import { type PageDocProps, type PageHeading, UniqueIdService } from "@qualcomm-ui/mdx-common";
|
|
3
3
|
import type { QuiPropTypes } from "@qualcomm-ui/typedoc-common";
|
|
4
|
-
import type
|
|
4
|
+
import { type IndexedSection } from "../markdown";
|
|
5
5
|
interface DocPropEntry {
|
|
6
6
|
name: string;
|
|
7
7
|
omitFrom?: string[];
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"doc-props-indexer.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/doc-props/doc-props-indexer.ts"],"names":[],"mappings":"AAOA,OAAO,EAAC,KAAK,MAAM,EAAU,MAAM,SAAS,CAAA;AAG5C,OAAO,EACL,KAAK,YAAY,EACjB,KAAK,WAAW,EAEhB,eAAe,EAChB,MAAM,yBAAyB,CAAA;AAChC,OAAO,KAAK,EAEV,YAAY,EACb,MAAM,6BAA6B,CAAA;AAEpC,OAAO,EAA4B,KAAK,cAAc,EAAC,MAAM,aAAa,CAAA;AAuD1E,UAAU,YAAY;IACpB,IAAI,EAAE,MAAM,CAAA;IACZ,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;CACpB;AAED,qBAAa,eAAe;IAC1B,eAAe,EAAE,YAAY,EAAE,CAAK;IACpC,SAAS,EAAE,eAAe,CAAwB;IAClD,OAAO,CAAC,QAAQ,CAAC,KAAK,CAA8B;IACpD,OAAO,CAAC,YAAY,CAAmB;gBAE3B,KAAK,EAAE,MAAM,CAAC,MAAM,EAAE,YAAY,CAAC;IAI/C,KAAK,IAAI,IAAI;IAKb;;;;OAIG;IACH,oBAAoB,EAAE,MAAM,CA6C3B;IAED,KAAK,CAAC,YAAY,EAAE,MAAM,EAAE,GAAG,EAAE,WAAW,EAAE,GAAG,cAAc,EAAE,GAAG,IAAI;IAgFxE,WAAW,IAAI,YAAY;IAY3B,OAAO,CAAC,YAAY;CAyBrB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/doc-props/index.ts"],"names":[],"mappings":"AAAA,cAAc,qBAAqB,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"docs-plugin.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/docs-plugin.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"docs-plugin.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/docs-plugin.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,YAAY,EAAiB,MAAM,MAAM,CAAA;AAetD,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAA;IAEnB;;;;OAIG;IACH,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAID,wBAAgB,aAAa,CAAC,IAAI,CAAC,EAAE,oBAAoB,GAAG,YAAY,CAyKvE"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"generate-page-map.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/generate-page-map.ts"],"names":[],"mappings":"
|
|
1
|
+
{"version":3,"file":"generate-page-map.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/generate-page-map.ts"],"names":[],"mappings":"AAaA,wBAAgB,yBAAyB,SAqDxC"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/index.ts"],"names":[],"mappings":"AAAA,cAAc,
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/docs-plugin/index.ts"],"names":[],"mappings":"AAAA,cAAc,UAAU,CAAA;AACxB,cAAc,eAAe,CAAA;AAC7B,mBAAmB,eAAe,CAAA;AAClC,cAAc,eAAe,CAAA;AAC7B,cAAc,UAAU,CAAA;AACxB,cAAc,UAAU,CAAA"}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* Converts heading text to a URL-friendly slug. Handles multi-word text,
|
|
3
|
+
* PascalCase identifiers, and single lowercase words. Does NOT deduplicate —
|
|
4
|
+
* callers manage their own counter state via {@link SlugGenerator}.
|
|
5
|
+
*/
|
|
6
|
+
export declare function slugify(text: string): string;
|
|
7
|
+
/**
|
|
8
|
+
* Stateful slug generator that appends `-1`, `-2`, etc. for duplicate slugs
|
|
9
|
+
* within a single page/document scope.
|
|
10
|
+
*/
|
|
11
|
+
export declare class SlugGenerator {
|
|
12
|
+
private seenIds;
|
|
13
|
+
reset(): void;
|
|
14
|
+
createSlug(text: string): string;
|
|
15
|
+
}
|
|
16
|
+
//# sourceMappingURL=create-slug.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"create-slug.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/markdown/create-slug.ts"],"names":[],"mappings":"AAGA;;;;GAIG;AACH,wBAAgB,OAAO,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,CAsB5C;AAED;;;GAGG;AACH,qBAAa,aAAa;IACxB,OAAO,CAAC,OAAO,CAA4B;IAE3C,KAAK,IAAI,IAAI;IAIb,UAAU,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM;CAMjC"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"frontmatter-schema.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/markdown/frontmatter-schema.ts"],"names":[],"mappings":"AAGA,OAAO,EAAI,KAAK,SAAS,EAAC,MAAM,KAAK,CAAA;AAMrC;;;GAGG;AACH,eAAO,MAAM,iBAAiB,EAAE,SAAS,CAAC,EAAE,CAiBxC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/docs-plugin/markdown/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,wBAAwB,CAAA;AACtC,mBAAmB,kBAAkB,CAAA;AACrC,cAAc,aAAa,CAAA;AAC3B,cAAc,mBAAmB,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"filter-frontmatter.d.ts","sourceRoot":"","sources":["../../../../src/docs-plugin/markdown/knowledge/filter-frontmatter.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAC,0BAA0B,EAAC,MAAM,cAAc,CAAA;AAE5D,wBAAgB,iBAAiB,CAC/B,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,EACpC,MAAM,EAAE,0BAA0B,GAAG,SAAS,GAC7C,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAyBzB"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../src/docs-plugin/markdown/knowledge/index.ts"],"names":[],"mappings":"AAAA,cAAc,sBAAsB,CAAA"}
|
|
@@ -0,0 +1,36 @@
|
|
|
1
|
+
import type { KnowledgePages, KnowledgeSections } from "@qualcomm-ui/mdx-common";
|
|
2
|
+
import type { KnowledgeExtraFile, KnowledgeFrontmatterConfig, PagesExportConfig, SectionExportConfig } from "../../config";
|
|
3
|
+
import type { MdxFileReader } from "../markdown-file-reader";
|
|
4
|
+
export interface KnowledgeExporterConfig {
|
|
5
|
+
baseUrl?: string;
|
|
6
|
+
docPropsPath?: string;
|
|
7
|
+
exclude?: string[];
|
|
8
|
+
extraFiles?: KnowledgeExtraFile[];
|
|
9
|
+
frontmatter?: KnowledgeFrontmatterConfig;
|
|
10
|
+
pageIdPrefix?: string;
|
|
11
|
+
pages?: PagesExportConfig;
|
|
12
|
+
routeDir: string;
|
|
13
|
+
sections?: SectionExportConfig;
|
|
14
|
+
verbose?: boolean;
|
|
15
|
+
}
|
|
16
|
+
/**
|
|
17
|
+
* Processes MDX documentation pages into structured JSON data (sections + pages).
|
|
18
|
+
* Does not write files — the caller handles persistence.
|
|
19
|
+
*/
|
|
20
|
+
export declare class KnowledgeExporter {
|
|
21
|
+
private readonly config;
|
|
22
|
+
private readonly fileReader;
|
|
23
|
+
private readonly propFormatter;
|
|
24
|
+
constructor(config: KnowledgeExporterConfig, fileReader: MdxFileReader);
|
|
25
|
+
generate(): Promise<{
|
|
26
|
+
pages: KnowledgePages;
|
|
27
|
+
sections: KnowledgeSections;
|
|
28
|
+
}>;
|
|
29
|
+
private scanPages;
|
|
30
|
+
private formatFrontmatterExpressions;
|
|
31
|
+
private transformRelativeUrls;
|
|
32
|
+
private processMdxContent;
|
|
33
|
+
private processMdxPage;
|
|
34
|
+
private processExtraFiles;
|
|
35
|
+
}
|
|
36
|
+
//# sourceMappingURL=knowledge-exporter.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"knowledge-exporter.d.ts","sourceRoot":"","sources":["../../../../src/docs-plugin/markdown/knowledge/knowledge-exporter.ts"],"names":[],"mappings":"AASA,OAAO,KAAK,EAEV,cAAc,EACd,iBAAiB,EAGlB,MAAM,yBAAyB,CAAA;AAEhC,OAAO,KAAK,EACV,kBAAkB,EAClB,0BAA0B,EAC1B,iBAAiB,EACjB,mBAAmB,EACpB,MAAM,cAAc,CAAA;AAKrB,OAAO,KAAK,EAAC,aAAa,EAAC,MAAM,yBAAyB,CAAA;AAe1D,MAAM,WAAW,uBAAuB;IACtC,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,OAAO,CAAC,EAAE,MAAM,EAAE,CAAA;IAClB,UAAU,CAAC,EAAE,kBAAkB,EAAE,CAAA;IACjC,WAAW,CAAC,EAAE,0BAA0B,CAAA;IACxC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,KAAK,CAAC,EAAE,iBAAiB,CAAA;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,QAAQ,CAAC,EAAE,mBAAmB,CAAA;IAC9B,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED;;;GAGG;AACH,qBAAa,iBAAiB;IAC5B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAyB;IAChD,OAAO,CAAC,QAAQ,CAAC,UAAU,CAAe;IAC1C,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAe;gBAEjC,MAAM,EAAE,uBAAuB,EAAE,UAAU,EAAE,aAAa;IAUhE,QAAQ,IAAI,OAAO,CAAC;QACxB,KAAK,EAAE,cAAc,CAAA;QACrB,QAAQ,EAAE,iBAAiB,CAAA;KAC5B,CAAC;YAwGY,SAAS;IA0EvB,OAAO,CAAC,4BAA4B;IA8CpC,OAAO,CAAC,qBAAqB;YAcf,iBAAiB;YAuBjB,cAAc;YA6Cd,iBAAiB;CAkDhC"}
|
package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/demo-plugin.d.ts
RENAMED
|
@@ -4,5 +4,5 @@ import type { Plugin } from "unified";
|
|
|
4
4
|
* Demo) with code blocks containing the demo source code from the demos folder.
|
|
5
5
|
* Imported files are added as sibling code blocks immediately after the demo.
|
|
6
6
|
*/
|
|
7
|
-
export declare function formatDemos(demosFolder: string | undefined): Plugin;
|
|
7
|
+
export declare function formatDemos(demosFolder: string | undefined, verbose?: boolean): Plugin;
|
|
8
8
|
//# sourceMappingURL=demo-plugin.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"demo-plugin.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/markdown/knowledge/plugins/demo-plugin.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAoDnC;;;;GAIG;AACH,wBAAgB,WAAW,CACzB,WAAW,EAAE,MAAM,GAAG,SAAS,EAC/B,OAAO,CAAC,EAAE,OAAO,GAChB,MAAM,CAyJR"}
|
package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge/plugins}/doc-props-plugin.d.ts
RENAMED
|
@@ -1,7 +1,17 @@
|
|
|
1
1
|
import type { Plugin } from "unified";
|
|
2
|
-
import type {
|
|
2
|
+
import type { SimplifiedProp } from "@qualcomm-ui/mdx-common";
|
|
3
|
+
import type { ComponentProps, DocProps } from "../types";
|
|
4
|
+
export interface PropFormatterOptions {
|
|
5
|
+
docPropsPath?: string;
|
|
6
|
+
routeDir: string;
|
|
7
|
+
verbose?: boolean;
|
|
8
|
+
}
|
|
3
9
|
export declare class PropFormatter {
|
|
4
10
|
private docProps;
|
|
11
|
+
private readonly docPropsPath?;
|
|
12
|
+
private readonly routeDir;
|
|
13
|
+
private readonly verbose;
|
|
14
|
+
constructor(options: PropFormatterOptions);
|
|
5
15
|
loadDocProps(): Promise<DocProps | null>;
|
|
6
16
|
private formatCommentParts;
|
|
7
17
|
private formatComment;
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"doc-props-plugin.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/markdown/knowledge/plugins/doc-props-plugin.ts"],"names":[],"mappings":"AAOA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAGnC,OAAO,KAAK,EAAC,cAAc,EAAC,MAAM,yBAAyB,CAAA;AAO3D,OAAO,KAAK,EAAC,cAAc,EAAE,QAAQ,EAAW,MAAM,UAAU,CAAA;AAoDhE,MAAM,WAAW,oBAAoB;IACnC,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,QAAQ,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED,qBAAa,aAAa;IACxB,OAAO,CAAC,QAAQ,CAAwB;IACxC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAC,CAAQ;IACtC,OAAO,CAAC,QAAQ,CAAC,QAAQ,CAAQ;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,OAAO,EAAE,oBAAoB;IAMnC,YAAY,IAAI,OAAO,CAAC,QAAQ,GAAG,IAAI,CAAC;IAoC9C,OAAO,CAAC,kBAAkB;IAoC1B,OAAO,CAAC,aAAa;IAoCrB,YAAY,CAAC,KAAK,EAAE,cAAc,EAAE,SAAS,EAAE,OAAO,GAAG,cAAc,EAAE;IA0BzE,OAAO,CAAC,eAAe;IAiBvB;;;OAGG;IACH,mBAAmB,IAAI,MAAM;CA8F9B"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"filter-text-directives.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/markdown/knowledge/plugins/filter-text-directives.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAKnC,eAAO,MAAM,oBAAoB,EAAE,MAYlC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/markdown/knowledge/plugins/index.ts"],"names":[],"mappings":"AAAA,cAAc,eAAe,CAAA;AAC7B,cAAc,oBAAoB,CAAA;AAClC,cAAc,0BAA0B,CAAA;AACxC,cAAc,2BAA2B,CAAA;AACzC,cAAc,oBAAoB,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"npm-install-tabs-plugin.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/markdown/knowledge/plugins/npm-install-tabs-plugin.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AAKnC,eAAO,MAAM,oBAAoB,EAAE,MAqClC,CAAA"}
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"qds-theme-plugin.d.ts","sourceRoot":"","sources":["../../../../../src/docs-plugin/markdown/knowledge/plugins/qds-theme-plugin.ts"],"names":[],"mappings":"AAIA,OAAO,KAAK,EAAC,MAAM,EAAC,MAAM,SAAS,CAAA;AA8CnC;;;GAGG;AACH,wBAAsB,gBAAgB,IAAI,OAAO,CAAC,MAAM,CAAC,CAwExD"}
|
package/dist/{ai-knowledge/generator → docs-plugin/markdown/knowledge}/section-extractor.d.ts
RENAMED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import type { Root } from "mdast";
|
|
2
|
-
import type { SectionEntry } from "
|
|
2
|
+
import type { PageEntry, PageHeading, SectionEntry } from "@qualcomm-ui/mdx-common";
|
|
3
3
|
export interface SectionExtractorOptions {
|
|
4
4
|
/**
|
|
5
5
|
* Header depths that define section boundaries.
|
|
@@ -11,24 +11,38 @@ export interface SectionExtractorOptions {
|
|
|
11
11
|
* @default 0
|
|
12
12
|
*/
|
|
13
13
|
minContentLength?: number;
|
|
14
|
+
/**
|
|
15
|
+
* Prefix to use for page IDs.
|
|
16
|
+
*/
|
|
17
|
+
pageIdPrefix?: string;
|
|
14
18
|
}
|
|
15
19
|
export interface PageInfo {
|
|
16
20
|
frontmatter: Record<string, unknown>;
|
|
17
21
|
id: string;
|
|
22
|
+
pathname: string;
|
|
18
23
|
title: string;
|
|
19
24
|
url?: string;
|
|
20
25
|
}
|
|
26
|
+
export interface ExtractionResult {
|
|
27
|
+
sections: SectionEntry[];
|
|
28
|
+
toc: PageHeading[];
|
|
29
|
+
}
|
|
21
30
|
/**
|
|
22
31
|
* Extracts sections from processed markdown content, organized by headers.
|
|
23
32
|
*/
|
|
24
33
|
export declare class SectionExtractor {
|
|
25
34
|
private readonly depths;
|
|
26
35
|
private readonly minContentLength;
|
|
36
|
+
private readonly pageIdPrefix;
|
|
27
37
|
constructor(options?: SectionExtractorOptions);
|
|
28
38
|
/**
|
|
29
|
-
* Extracts sections from a parsed AST.
|
|
39
|
+
* Extracts sections from a parsed AST and generates a table of contents.
|
|
40
|
+
*/
|
|
41
|
+
extract(tree: Root, pageInfo: PageInfo): ExtractionResult;
|
|
42
|
+
/**
|
|
43
|
+
* Extracts the entire page as a single entry with full raw markdown content.
|
|
30
44
|
*/
|
|
31
|
-
|
|
45
|
+
extractPage(tree: Root, pageInfo: PageInfo): PageEntry | null;
|
|
32
46
|
private buildSectionEntry;
|
|
33
47
|
private extractTerms;
|
|
34
48
|
private parseTermsBlock;
|
|
@@ -40,6 +54,5 @@ export declare class SectionExtractor {
|
|
|
40
54
|
private nodesToRawContent;
|
|
41
55
|
private nodesToContent;
|
|
42
56
|
private generateSectionId;
|
|
43
|
-
private generateAnchorId;
|
|
44
57
|
}
|
|
45
58
|
//# sourceMappingURL=section-extractor.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"section-extractor.d.ts","sourceRoot":"","sources":["../../../../src/docs-plugin/markdown/knowledge/section-extractor.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAqB,IAAI,EAAoB,MAAM,OAAO,CAAA;AAOtE,OAAO,KAAK,EAEV,SAAS,EACT,WAAW,EACX,YAAY,EAGb,MAAM,yBAAyB,CAAA;AAOhC,MAAM,WAAW,uBAAuB;IACtC;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,EAAE,CAAA;IAEjB;;;OAGG;IACH,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAA;CACtB;AAED,MAAM,WAAW,QAAQ;IACvB,WAAW,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAA;IACpC,EAAE,EAAE,MAAM,CAAA;IACV,QAAQ,EAAE,MAAM,CAAA;IAChB,KAAK,EAAE,MAAM,CAAA;IACb,GAAG,CAAC,EAAE,MAAM,CAAA;CACb;AAeD,MAAM,WAAW,gBAAgB;IAC/B,QAAQ,EAAE,YAAY,EAAE,CAAA;IACxB,GAAG,EAAE,WAAW,EAAE,CAAA;CACnB;AAED;;GAEG;AACH,qBAAa,gBAAgB;IAC3B,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAa;IACpC,OAAO,CAAC,QAAQ,CAAC,gBAAgB,CAAQ;IACzC,OAAO,CAAC,QAAQ,CAAC,YAAY,CAAQ;gBAEzB,OAAO,CAAC,EAAE,uBAAuB;IAO7C;;OAEG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,GAAG,gBAAgB;IA2FzD;;OAEG;IACH,WAAW,CAAC,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,GAAG,SAAS,GAAG,IAAI;IA6B7D,OAAO,CAAC,iBAAiB;IAmEzB,OAAO,CAAC,YAAY;IAwCpB,OAAO,CAAC,eAAe;IAYvB;;;OAGG;IACH,OAAO,CAAC,cAAc;IAkBtB,OAAO,CAAC,iBAAiB;IAMzB,OAAO,CAAC,cAAc;IAUtB,OAAO,CAAC,iBAAiB;CAG1B"}
|