@vezham/docs-core 1.0.1

package/dist/content/github.js

@@ -0,0 +1,28 @@
+//#region src/content/github.ts
+/**
+* Get the last edit time of a file using GitHub API
+*
+* By default, this will cache the result forever.
+* Set `options.next.revalidate` to customize this.
+*/
+async function getGithubLastEdit({ repo, token, owner, path, sha, baseUrl = "https://api.github.com", options = {}, params: customParams = {} }) {
+	const headers = new Headers(options.headers);
+	const params = new URLSearchParams();
+	params.set("path", path);
+	params.set("page", "1");
+	params.set("per_page", "1");
+	if (sha) params.set("sha", sha);
+	for (const [key, value] of Object.entries(customParams)) params.set(key, value);
+	if (token) headers.append("authorization", token);
+	const res = await fetch(`${baseUrl}/repos/${owner}/${repo}/commits?${params.toString()}`, {
+		cache: "force-cache",
+		...options,
+		headers
+	});
+	if (!res.ok) throw new Error(`Failed to fetch last edit time from Git ${await res.text()}`);
+	const data = await res.json();
+	if (data.length === 0) return null;
+	return new Date(data[0].commit.committer.date);
+}
+//#endregion
+export { getGithubLastEdit };

package/dist/content/md/frontmatter.d.ts

@@ -0,0 +1,15 @@
+//#region src/content/md/frontmatter.d.ts
+interface Output {
+  /**
+   * The matter section, including the delimiter.
+   */
+  matter: string;
+  content: string;
+  data: unknown;
+}
+/**
+ * parse frontmatter, it supports only yaml format
+ */
+declare function frontmatter(input: string): Output;
+//#endregion
+export { frontmatter };

package/dist/content/md/frontmatter.js

@@ -0,0 +1,24 @@
+import { parse } from "yaml";
+//#region src/content/md/frontmatter.ts
+/**
+* Inspired by https://github.com/jonschlinkert/gray-matter
+*/
+const regex = /^---\r?\n(.+?)\r?\n---\r?\n?/s;
+/**
+* parse frontmatter, it supports only yaml format
+*/
+function frontmatter(input) {
+	const output = {
+		matter: "",
+		data: {},
+		content: input
+	};
+	const match = regex.exec(input);
+	if (!match) return output;
+	output.matter = match[0];
+	output.content = input.slice(match[0].length);
+	output.data = parse(match[1]) ?? {};
+	return output;
+}
+//#endregion
+export { frontmatter };

package/dist/content/md.d.ts

@@ -0,0 +1,24 @@
+import { FC } from "react";
+import { Options } from "remark-rehype";
+import { Compatible } from "vfile";
+import { Components } from "hast-util-to-jsx-runtime";
+import { PluggableList } from "unified";
+//#region src/content/md.d.ts
+interface MarkdownRendererOptions {
+  remarkPlugins?: PluggableList;
+  rehypePlugins?: PluggableList;
+  remarkRehypeOptions?: Options;
+}
+interface MarkdownRenderer {
+  Markdown: FC<MarkdownProps>;
+  MarkdownServer: FC<Omit<MarkdownProps, 'async'>>;
+}
+interface MarkdownProps {
+  async?: boolean;
+  components?: Components;
+  children: Compatible;
+}
+declare function createMarkdownRenderer({ rehypePlugins, remarkPlugins, remarkRehypeOptions }?: MarkdownRendererOptions): MarkdownRenderer;
+declare function Markdown(props: MarkdownProps & MarkdownRendererOptions): import("react").ReactNode | Promise<import("react").ReactNode>;
+//#endregion
+export { Markdown, MarkdownProps, MarkdownRenderer, MarkdownRendererOptions, createMarkdownRenderer };

package/dist/content/md.js

@@ -0,0 +1,43 @@
+import { use, useMemo } from "react";
+import * as JsxRuntime from "react/jsx-runtime";
+import { remark } from "remark";
+import remarkRehype from "remark-rehype";
+import { VFile } from "vfile";
+import { toJsxRuntime } from "hast-util-to-jsx-runtime";
+//#region src/content/md.ts
+function createMarkdownRenderer({ rehypePlugins = [], remarkPlugins = [], remarkRehypeOptions } = {}) {
+	const processor = remark().use(remarkPlugins).use(remarkRehype, remarkRehypeOptions).use(rehypePlugins);
+	const promises = {};
+	function render(tree, file, props) {
+		return toJsxRuntime(tree, {
+			development: false,
+			filePath: file.path,
+			components: props.components,
+			...JsxRuntime
+		});
+	}
+	function parse(file) {
+		return processor.parse(file);
+	}
+	return {
+		Markdown(props) {
+			const { async = false, children } = props;
+			const file = new VFile(children);
+			const id = `${file.path}:${file.value}`;
+			if (async) {
+				promises[id] ??= processor.run(parse(file), file);
+				return render(use(promises[id]), file, props);
+			}
+			return render(useMemo(() => processor.runSync(parse(file), file), [id]), file, props);
+		},
+		async MarkdownServer(props) {
+			const file = new VFile(props.children);
+			return render(await processor.run(parse(file), file), file, props);
+		}
+	};
+}
+function Markdown(props) {
+	return createMarkdownRenderer(props).MarkdownServer(props);
+}
+//#endregion
+export { Markdown, createMarkdownRenderer };

package/dist/content/mdx/preset-bundler.d.ts

@@ -0,0 +1,29 @@
+import { t as RehypeCodeOptions } from "../../rehype-code-D-RFJb9W.js";
+import { t as RemarkImageOptions } from "../../remark-image-BI2S9LOb.js";
+import { r as StructureOptions } from "../../remark-structure-CnHwvNZr.js";
+import { t as RemarkHeadingOptions } from "../../remark-heading-DEIzTkU5.js";
+import { t as RemarkCodeTabOptions } from "../../remark-code-tab-DE_4bdnu.js";
+import { t as RemarkNpmOptions } from "../../remark-npm-BbpvkJaT.js";
+import "../../index-DAYtLGbx.js";
+import { t as ResolvePlugins } from "../../util-BDsqOxh3.js";
+import { Pluggable } from "unified";
+import { ProcessorOptions } from "@mdx-js/mdx";
+//#region src/content/mdx/preset-bundler.d.ts
+type MDXBundlerPresetOptions = Omit<NonNullable<ProcessorOptions>, 'rehypePlugins' | 'remarkPlugins'> & {
+  rehypePlugins?: ResolvePlugins;
+  remarkPlugins?: ResolvePlugins;
+  /** @private for `remark-include` */
+  _include?: Pluggable;
+  remarkStructureOptions?: StructureOptions | false;
+  remarkHeadingOptions?: RemarkHeadingOptions | false;
+  remarkImageOptions?: RemarkImageOptions | false;
+  remarkCodeTabOptions?: RemarkCodeTabOptions | false;
+  remarkNpmOptions?: RemarkNpmOptions | false;
+  rehypeCodeOptions?: RehypeCodeOptions | false;
+};
+/**
+ * apply MDX processor presets
+ */
+declare function mdxPreset(options?: MDXBundlerPresetOptions): Promise<ProcessorOptions>;
+//#endregion
+export { MDXBundlerPresetOptions, mdxPreset };

package/dist/content/mdx/preset-bundler.js

@@ -0,0 +1,39 @@
+import { t as resolvePlugins } from "../../util-DjBr9b3w.js";
+//#region src/content/mdx/preset-bundler.ts
+/**
+* apply MDX processor presets
+*/
+async function mdxPreset(options = {}) {
+	const { rehypeCodeOptions, remarkImageOptions, remarkHeadingOptions, remarkStructureOptions, remarkCodeTabOptions, remarkNpmOptions, _include, ...mdxOptions } = options;
+	const remarkPlugins = await resolvePlugins((v) => [
+		import("remark-gfm").then((mod) => mod.default),
+		remarkHeadingOptions !== false && import("../../mdx-plugins/remark-heading.js").then((mod) => [mod.remarkHeading, {
+			generateToc: false,
+			...remarkHeadingOptions
+		}]),
+		_include ?? false,
+		remarkImageOptions !== false && import("../../mdx-plugins/remark-image.js").then((mod) => [mod.remarkImage, {
+			...remarkImageOptions,
+			useImport: remarkImageOptions?.useImport ?? true
+		}]),
+		remarkCodeTabOptions !== false && import("../../mdx-plugins/remark-code-tab.js").then((mod) => [mod.remarkCodeTab, remarkCodeTabOptions]),
+		remarkNpmOptions !== false && import("../../mdx-plugins/remark-npm.js").then((mod) => [mod.remarkNpm, remarkNpmOptions]),
+		...v,
+		remarkStructureOptions !== false && import("../../mdx-plugins/remark-structure.js").then((mod) => [mod.remarkStructure, {
+			exportAs: "structuredData",
+			...remarkStructureOptions
+		}])
+	], mdxOptions.remarkPlugins);
+	const rehypePlugins = await resolvePlugins((v) => [
+		rehypeCodeOptions !== false && import("../../mdx-plugins/rehype-code.js").then((mod) => [mod.rehypeCode, rehypeCodeOptions]),
+		...v,
+		import("../../mdx-plugins/rehype-toc.js").then((mod) => mod.rehypeToc)
+	], mdxOptions.rehypePlugins);
+	return {
+		...mdxOptions,
+		remarkPlugins,
+		rehypePlugins
+	};
+}
+//#endregion
+export { mdxPreset };

package/dist/content/mdx/preset-runtime.d.ts

@@ -0,0 +1,26 @@
+import { t as RehypeCodeOptions } from "../../rehype-code-D-RFJb9W.js";
+import { t as RemarkImageOptions } from "../../remark-image-BI2S9LOb.js";
+import { r as StructureOptions } from "../../remark-structure-CnHwvNZr.js";
+import { t as RemarkHeadingOptions } from "../../remark-heading-DEIzTkU5.js";
+import { t as RemarkCodeTabOptions } from "../../remark-code-tab-DE_4bdnu.js";
+import { t as RemarkNpmOptions } from "../../remark-npm-BbpvkJaT.js";
+import "../../index-DAYtLGbx.js";
+import { t as ResolvePlugins } from "../../util-BDsqOxh3.js";
+import { ProcessorOptions } from "@mdx-js/mdx";
+//#region src/content/mdx/preset-runtime.d.ts
+type MDXRuntimePresetOptions = Omit<NonNullable<ProcessorOptions>, 'rehypePlugins' | 'remarkPlugins'> & {
+  rehypePlugins?: ResolvePlugins;
+  remarkPlugins?: ResolvePlugins;
+  remarkStructureOptions?: StructureOptions | false;
+  remarkHeadingOptions?: RemarkHeadingOptions | false;
+  remarkImageOptions?: RemarkImageOptions | false;
+  remarkCodeTabOptions?: RemarkCodeTabOptions | false;
+  remarkNpmOptions?: RemarkNpmOptions | false;
+  rehypeCodeOptions?: RehypeCodeOptions | false;
+};
+/**
+ * apply MDX processor presets
+ */
+declare function mdxPreset(options?: MDXRuntimePresetOptions): Promise<ProcessorOptions>;
+//#endregion
+export { MDXRuntimePresetOptions, mdxPreset };

package/dist/content/mdx/preset-runtime.js

@@ -0,0 +1,36 @@
+import { t as resolvePlugins } from "../../util-DjBr9b3w.js";
+//#region src/content/mdx/preset-runtime.ts
+/**
+* apply MDX processor presets
+*/
+async function mdxPreset(options = {}) {
+	const { rehypeCodeOptions, remarkImageOptions, remarkHeadingOptions, remarkStructureOptions, remarkCodeTabOptions, remarkNpmOptions, outputFormat = "function-body", ...mdxOptions } = options;
+	const remarkPlugins = await resolvePlugins((v) => [
+		import("remark-gfm").then((mod) => mod.default),
+		remarkHeadingOptions !== false && import("../../mdx-plugins/remark-heading.js").then((mod) => [mod.remarkHeading, {
+			generateToc: false,
+			...remarkHeadingOptions
+		}]),
+		remarkImageOptions !== false && import("../../mdx-plugins/remark-image.js").then((mod) => [mod.remarkImage, remarkImageOptions]),
+		remarkCodeTabOptions !== false && import("../../mdx-plugins/remark-code-tab.js").then((mod) => [mod.remarkCodeTab, remarkCodeTabOptions]),
+		remarkNpmOptions !== false && import("../../mdx-plugins/remark-npm.js").then((mod) => [mod.remarkNpm, remarkNpmOptions]),
+		...v,
+		remarkStructureOptions !== false && import("../../mdx-plugins/remark-structure.js").then((mod) => [mod.remarkStructure, {
+			exportAs: "structuredData",
+			...remarkStructureOptions
+		}])
+	], mdxOptions.remarkPlugins);
+	const rehypePlugins = await resolvePlugins((v) => [
+		rehypeCodeOptions !== false && import("../../mdx-plugins/rehype-code.js").then((mod) => [mod.rehypeCode, rehypeCodeOptions]),
+		...v,
+		import("../../mdx-plugins/rehype-toc.js").then((mod) => mod.rehypeToc)
+	], mdxOptions.rehypePlugins);
+	return {
+		...mdxOptions,
+		outputFormat,
+		remarkPlugins,
+		rehypePlugins
+	};
+}
+//#endregion
+export { mdxPreset };

package/dist/content/toc.d.ts

@@ -0,0 +1,19 @@
+import { c as TOCItemType } from "../toc-CtW5lwA1.js";
+import { Compatible } from "vfile";
+import { PluggableList } from "unified";
+//#region src/content/toc.d.ts
+/**
+ * Get Table of Contents from markdown/mdx document (using remark)
+ *
+ * @param content - Markdown content or file
+ */
+declare function getTableOfContents(content: Compatible): TOCItemType[];
+/**
+ * Get Table of Contents from markdown/mdx document (using remark)
+ *
+ * @param content - Markdown content or file
+ * @param remarkPlugins - remark plugins to be applied first
+ */
+declare function getTableOfContents(content: Compatible, remarkPlugins: PluggableList): Promise<TOCItemType[]>;
+//#endregion
+export { getTableOfContents };

package/dist/content/toc.js

@@ -0,0 +1,14 @@
+import { remarkHeading } from "../mdx-plugins/remark-heading.js";
+import { remark } from "remark";
+//#region src/content/toc.ts
+function getTableOfContents(content, remarkPlugins) {
+	if (remarkPlugins) return remark().use(remarkPlugins).use(remarkHeading).process(content).then((result) => {
+		if ("toc" in result.data) return result.data.toc;
+		return [];
+	});
+	const result = remark().use(remarkHeading).processSync(content);
+	if ("toc" in result.data) return result.data.toc;
+	return [];
+}
+//#endregion
+export { getTableOfContents };

package/dist/definitions-CFOhwE1k.d.ts

@@ -0,0 +1,72 @@
+import { ReactNode } from "react";
+//#region src/page-tree/definitions.d.ts
+interface ID {
+  /**
+   * ID for the node, unique in all page trees (even across different locales)
+   */
+  $id?: string;
+}
+interface Root extends ID {
+  /**
+   * @internal folder `$ref`
+   */
+  $ref?: Folder['$ref'];
+  type?: 'root';
+  name: ReactNode;
+  description?: ReactNode;
+  children: Node[];
+  /**
+   * Another page tree that won't be displayed unless being opened.
+   */
+  fallback?: Root;
+}
+type Node = Item | Separator | Folder;
+interface Item extends ID {
+  /**
+   * @internal page file path
+   */
+  $ref?: string;
+  type: 'page';
+  name: ReactNode;
+  url: string;
+  /**
+   * Whether the link should be treated as external (e.g. use HTML <a> tag).
+   *
+   * When unspecified, it depends on the value of `url`.
+   */
+  external?: boolean;
+  description?: ReactNode;
+  icon?: ReactNode;
+}
+interface Separator extends ID {
+  type: 'separator';
+  name?: ReactNode;
+  icon?: ReactNode;
+}
+interface Folder extends ID {
+  /**
+   * @internal paths of meta file & folder
+   */
+  $ref?: {
+    meta?: string;
+    folder: string;
+  };
+  type: 'folder';
+  name: ReactNode;
+  description?: ReactNode;
+  /**
+   * Mark as a root folder, `true` for the default type.
+   *
+   * A string value specifies its **root type**: root folders of the same type
+   * under the same parent scope are interchangeable (e.g. versions), and pages
+   * can map to their structural projection in another root.
+   */
+  root?: boolean | string;
+  defaultOpen?: boolean;
+  collapsible?: boolean;
+  index?: Item;
+  icon?: ReactNode;
+  children: Node[];
+}
+//#endregion
+export { Separator as a, Root as i, Item as n, Node as r, Folder as t };