@octanejs/docusaurus 0.0.1

package/types/mdx.d.ts

@@ -0,0 +1,60 @@
+import type { CompileOptions } from '@mdx-js/mdx';
+import type { CompileMdxOptions, CompileMdxResult } from '@octanejs/mdx/compile';
+
+export interface DocusaurusTocItem {
+	value: string;
+	id: string;
+	level: number;
+}
+
+export interface DocusaurusMarkdownLinkInput {
+	linkPathname: string;
+	sourceFilePath: string;
+}
+
+export interface DocusaurusMdxImageTransformInput {
+	url: string;
+	sourceFilePath: string;
+}
+
+export interface DocusaurusMdxAssetInput {
+	frontMatter: Record<string, unknown>;
+	filePath: string;
+}
+
+export interface CompileDocusaurusMdxOptions extends Omit<
+	CompileMdxOptions,
+	'remarkPlugins' | 'rehypePlugins' | 'recmaPlugins'
+> {
+	metadata?: Record<string, any>;
+	createAssets?(input: DocusaurusMdxAssetInput): Record<string, any>;
+	resolveMarkdownLink?(input: DocusaurusMarkdownLinkInput): string | null;
+	resolveMarkdownImage?(input: DocusaurusMdxImageTransformInput): string;
+	removeContentTitle?: boolean;
+	anchorsMaintainCase?: boolean;
+	tocMinHeadingLevel?: number;
+	tocMaxHeadingLevel?: number;
+	beforeDefaultRemarkPlugins?: CompileOptions['remarkPlugins'];
+	remarkPlugins?: CompileOptions['remarkPlugins'];
+	beforeDefaultRehypePlugins?: CompileOptions['rehypePlugins'];
+	rehypePlugins?: CompileOptions['rehypePlugins'];
+	recmaPlugins?: CompileOptions['recmaPlugins'];
+}
+
+export declare function remarkDocusaurusPageData(
+	options?: CompileDocusaurusMdxOptions,
+): (tree: any, file: any) => void;
+
+export declare function recmaDocusaurusPageExports(): (tree: any, file: any) => void;
+
+export declare function compileDocusaurusMdx(
+	source: string,
+	id: string,
+	options?: CompileDocusaurusMdxOptions,
+): Promise<CompileMdxResult>;
+
+export declare function compileDocusaurusMdxSync(
+	source: string,
+	id: string,
+	options?: CompileDocusaurusMdxOptions,
+): CompileMdxResult;

package/types/vite.d.ts

@@ -0,0 +1,66 @@
+import type { CompileMdxResult } from '@octanejs/mdx/compile';
+import type { DocusaurusManifest, LoadDocusaurusSiteOptions } from './index.js';
+import type { CompileDocusaurusMdxOptions } from './mdx.js';
+
+export declare const DOCUSAURUS_MANIFEST_ID = 'virtual:octane-docusaurus-manifest';
+
+export interface DocusaurusMdxPluginOptions extends Omit<
+	CompileDocusaurusMdxOptions,
+	'mode' | 'hmr' | 'dev' | 'metadata'
+> {
+	ssr?: boolean;
+	md?: boolean;
+	hmr?: boolean;
+	profile?: boolean;
+	metadata?:
+		| Record<string, any>
+		| ((id: string) => Record<string, any> | undefined | Promise<Record<string, any> | undefined>);
+}
+
+export interface DocusaurusViteOptions extends LoadDocusaurusSiteOptions {
+	mdx?: DocusaurusMdxPluginOptions;
+}
+
+export interface DocusaurusBridgePlugin {
+	name: 'octane-docusaurus-bridge';
+	enforce: 'pre';
+	api: {
+		getManifest(): Promise<DocusaurusManifest>;
+		reload(): Promise<DocusaurusManifest>;
+	};
+	configResolved(config: { root?: string; command: string }): Promise<void>;
+	buildStart(this: { addWatchFile?(id: string): void }): Promise<void>;
+	watchChange(id: string): Promise<void>;
+	resolveId(id: string): Promise<string | null>;
+	load(id: string): Promise<string | null>;
+}
+
+export interface DocusaurusMdxPlugin {
+	name: 'octane-docusaurus-mdx';
+	enforce: 'pre';
+	configResolved(config: { root?: string; command: string }): void;
+	watchChange(id: string): void;
+	transform(
+		this: {
+			addWatchFile?(id: string): void;
+			warn?(warning: {
+				code: string;
+				message: string;
+				id: string;
+				loc: { file: string; line: number; column: number };
+			}): void;
+			environment?: { config?: { consumer?: string } };
+		},
+		code: string,
+		id: string,
+		options?: { ssr?: boolean },
+	): Promise<CompileMdxResult | null>;
+}
+
+export declare function docusaurusBridge(options?: DocusaurusViteOptions): DocusaurusBridgePlugin;
+
+export declare function docusaurusMdx(options?: DocusaurusMdxPluginOptions): DocusaurusMdxPlugin;
+
+export declare function docusaurus(
+	options?: DocusaurusViteOptions,
+): [DocusaurusBridgePlugin, DocusaurusMdxPlugin];