@ox-content/vite-plugin 3.0.0-alpha.8 → 3.0.0-beta.0

package/dist/reader-chrome.d.cts

@@ -0,0 +1,103 @@
+/**
+ * Per-control flags for `ssg.readerChrome`.
+ *
+ * Omitted fields stay on when the feature itself is enabled.
+ */
+export interface ReaderChromeOptions {
+  /**
+   * Copy button on fenced code blocks. The clipboard is read in the browser,
+   * never at build time.
+   *
+   * @default true
+   */
+  copy?: boolean;
+
+  /**
+   * Icon and `rel="noopener noreferrer"` on outbound `http(s)` links.
+   * Relative, hash, and same-document links are left alone.
+   *
+   * @default true
+   */
+  externalLinks?: boolean;
+
+  /**
+   * Back-to-top control that appears after the page is scrolled.
+   *
+   * @default true
+   */
+  backToTop?: boolean;
+}
+
+/**
+ * Resolved reader chrome. `false` means no extra markup or JS.
+ */
+export type ResolvedReaderChrome =
+  | false
+  | {
+      copy: boolean;
+      externalLinks: boolean;
+      backToTop: boolean;
+    };
+
+type EnabledReaderChrome = Exclude<ResolvedReaderChrome, false>;
+
+export type ReaderChromeInput =
+  | boolean
+  | ReaderChromeOptions
+  | EnabledReaderChrome
+  | undefined;
+
+/**
+ * Resolve the public reader-chrome option shape.
+ */
+export declare function resolveReaderChromeInput(
+  input?: ReaderChromeInput,
+): ResolvedReaderChrome;
+
+/**
+ * Apply the same native reader-chrome HTML transform used by the built-in SSG.
+ */
+export declare function applyReaderChromeHtml(
+  html: string,
+  input?: ReaderChromeInput,
+): string;
+
+/**
+ * Root attributes consumed by the browser runtime.
+ */
+export declare function readerChromeAttributes(
+  input?: ReaderChromeInput,
+): Readonly<Record<string, "">>;
+
+/**
+ * Render the root attributes as a leading-space HTML fragment.
+ */
+export declare function renderReaderChromeAttributes(input?: ReaderChromeInput): string;
+
+/**
+ * CSS shared by the built-in SSG and custom hosts.
+ */
+export declare function readerChromeCss(input?: ReaderChromeInput): string;
+
+/**
+ * Auto-initializing script shared by the built-in SSG and custom hosts.
+ */
+export declare function readerChromeScript(input?: ReaderChromeInput): string;
+
+/**
+ * Inline stylesheet tag for hosts that do not import
+ * `@ox-content/vite-plugin/styles/reader-chrome.css`.
+ */
+export declare function renderReaderChromeStyleTag(input?: ReaderChromeInput): string;
+
+/**
+ * Inline auto-init script for static hosts that do not bundle
+ * `@ox-content/vite-plugin/reader-chrome/client`.
+ */
+export declare function renderReaderChromeScriptTag(input?: ReaderChromeInput): string;
+
+export declare function readerChromeIsEnabled(
+  chrome: ResolvedReaderChrome,
+): chrome is Exclude<ResolvedReaderChrome, false>;
+
+export declare function readerChromeNeedsJs(chrome: ResolvedReaderChrome): boolean;

package/dist/reader-chrome.d.mts

@@ -0,0 +1,103 @@
+/**
+ * Per-control flags for `ssg.readerChrome`.
+ *
+ * Omitted fields stay on when the feature itself is enabled.
+ */
+export interface ReaderChromeOptions {
+  /**
+   * Copy button on fenced code blocks. The clipboard is read in the browser,
+   * never at build time.
+   *
+   * @default true
+   */
+  copy?: boolean;
+
+  /**
+   * Icon and `rel="noopener noreferrer"` on outbound `http(s)` links.
+   * Relative, hash, and same-document links are left alone.
+   *
+   * @default true
+   */
+  externalLinks?: boolean;
+
+  /**
+   * Back-to-top control that appears after the page is scrolled.
+   *
+   * @default true
+   */
+  backToTop?: boolean;
+}
+
+/**
+ * Resolved reader chrome. `false` means no extra markup or JS.
+ */
+export type ResolvedReaderChrome =
+  | false
+  | {
+      copy: boolean;
+      externalLinks: boolean;
+      backToTop: boolean;
+    };
+
+type EnabledReaderChrome = Exclude<ResolvedReaderChrome, false>;
+
+export type ReaderChromeInput =
+  | boolean
+  | ReaderChromeOptions
+  | EnabledReaderChrome
+  | undefined;
+
+/**
+ * Resolve the public reader-chrome option shape.
+ */
+export declare function resolveReaderChromeInput(
+  input?: ReaderChromeInput,
+): ResolvedReaderChrome;
+
+/**
+ * Apply the same native reader-chrome HTML transform used by the built-in SSG.
+ */
+export declare function applyReaderChromeHtml(
+  html: string,
+  input?: ReaderChromeInput,
+): string;
+
+/**
+ * Root attributes consumed by the browser runtime.
+ */
+export declare function readerChromeAttributes(
+  input?: ReaderChromeInput,
+): Readonly<Record<string, "">>;
+
+/**
+ * Render the root attributes as a leading-space HTML fragment.
+ */
+export declare function renderReaderChromeAttributes(input?: ReaderChromeInput): string;
+
+/**
+ * CSS shared by the built-in SSG and custom hosts.
+ */
+export declare function readerChromeCss(input?: ReaderChromeInput): string;
+
+/**
+ * Auto-initializing script shared by the built-in SSG and custom hosts.
+ */
+export declare function readerChromeScript(input?: ReaderChromeInput): string;
+
+/**
+ * Inline stylesheet tag for hosts that do not import
+ * `@ox-content/vite-plugin/styles/reader-chrome.css`.
+ */
+export declare function renderReaderChromeStyleTag(input?: ReaderChromeInput): string;
+
+/**
+ * Inline auto-init script for static hosts that do not bundle
+ * `@ox-content/vite-plugin/reader-chrome/client`.
+ */
+export declare function renderReaderChromeScriptTag(input?: ReaderChromeInput): string;
+
+export declare function readerChromeIsEnabled(
+  chrome: ResolvedReaderChrome,
+): chrome is Exclude<ResolvedReaderChrome, false>;
+
+export declare function readerChromeNeedsJs(chrome: ResolvedReaderChrome): boolean;

package/dist/reader-chrome.mjs

@@ -0,0 +1,98 @@
+import { n as importNapiModuleSync } from "./napi.mjs";
+//#region src/reader-chrome.ts
+const EMPTY_ATTRIBUTES = Object.freeze({});
+/**
+* Resolve the public reader-chrome option shape.
+*
+* `true` mirrors `ssg.readerChrome: true`: copy, outbound-link decoration, and
+* back-to-top are enabled. Object fields default on, so `{ copy: false }`
+* disables only the copy button.
+*/
+function resolveReaderChromeInput(input = true) {
+	if (!input) return false;
+	if (input === true) return {
+		copy: true,
+		externalLinks: true,
+		backToTop: true
+	};
+	return {
+		copy: input.copy ?? true,
+		externalLinks: input.externalLinks ?? true,
+		backToTop: input.backToTop ?? true
+	};
+}
+/**
+* Apply the same native reader-chrome HTML transform used by the built-in SSG.
+*
+* This rewrites rendered article HTML. It wraps fenced `<pre>` blocks for copy
+* controls and decorates outbound links when enabled. Back-to-top remains a
+* document-shell control, so it is exposed through the asset helpers.
+*/
+function applyReaderChromeHtml(html, input = true) {
+	const chrome = resolveReaderChromeInput(input);
+	if (!chrome || !chrome.copy && !chrome.externalLinks) return html;
+	return importNapiModuleSync().applySsgReaderChromeHtml(html, {
+		copy: chrome.copy,
+		externalLinks: chrome.externalLinks,
+		backToTop: chrome.backToTop
+	});
+}
+/**
+* Root attributes consumed by the browser runtime.
+*/
+function readerChromeAttributes(input = true) {
+	const chrome = resolveReaderChromeInput(input);
+	if (!readerChromeIsEnabled(chrome)) return EMPTY_ATTRIBUTES;
+	return {
+		"data-ox-reader-chrome": "",
+		...chrome.copy ? { "data-ox-copy": "" } : {},
+		...chrome.externalLinks ? { "data-ox-external-links": "" } : {},
+		...chrome.backToTop ? { "data-ox-back-to-top": "" } : {}
+	};
+}
+/**
+* Render the root attributes as a leading-space HTML fragment.
+*
+* Useful in template strings: `<article${renderReaderChromeAttributes()}>`.
+*/
+function renderReaderChromeAttributes(input = true) {
+	return Object.keys(readerChromeAttributes(input)).map((name) => ` ${name}`).join("");
+}
+/**
+* CSS shared by the built-in SSG and custom hosts.
+*/
+function readerChromeCss(input = true) {
+	return readerChromeIsEnabled(resolveReaderChromeInput(input)) ? importNapiModuleSync().getSsgReaderChromeCss() : "";
+}
+/**
+* Auto-initializing script shared by the built-in SSG and custom hosts.
+*/
+function readerChromeScript(input = true) {
+	return readerChromeNeedsJs(resolveReaderChromeInput(input)) ? importNapiModuleSync().getSsgReaderChromeScript() : "";
+}
+/**
+* Inline stylesheet tag for hosts that do not import
+* `@ox-content/vite-plugin/styles/reader-chrome.css`.
+*/
+function renderReaderChromeStyleTag(input = true) {
+	const css = readerChromeCss(input);
+	return css ? `<style data-ox-style="reader-chrome">\n${css}</style>` : "";
+}
+/**
+* Inline auto-init script for static hosts that do not bundle
+* `@ox-content/vite-plugin/reader-chrome/client`.
+*/
+function renderReaderChromeScriptTag(input = true) {
+	const js = readerChromeScript(input);
+	return js ? `<script data-ox-script="reader-chrome">\n${js}<\/script>` : "";
+}
+function readerChromeIsEnabled(chrome) {
+	return Boolean(chrome && (chrome.copy || chrome.externalLinks || chrome.backToTop));
+}
+function readerChromeNeedsJs(chrome) {
+	return Boolean(chrome && (chrome.copy || chrome.backToTop));
+}
+//#endregion
+export { applyReaderChromeHtml, readerChromeAttributes, readerChromeCss, readerChromeIsEnabled, readerChromeNeedsJs, readerChromeScript, renderReaderChromeAttributes, renderReaderChromeScriptTag, renderReaderChromeStyleTag, resolveReaderChromeInput };
+
+//# sourceMappingURL=reader-chrome.mjs.map

package/dist/reader-chrome.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"reader-chrome.mjs","names":[],"sources":["../src/reader-chrome.ts"],"sourcesContent":["import { importNapiModuleSync } from \"./napi\";\nimport type { ReaderChromeOptions, ResolvedReaderChrome } from \"./reader-chrome-options\";\n\nexport type { ReaderChromeOptions, ResolvedReaderChrome };\n\ntype EnabledReaderChrome = Exclude<ResolvedReaderChrome, false>;\n\nexport type ReaderChromeInput = boolean | ReaderChromeOptions | EnabledReaderChrome | undefined;\n\nconst EMPTY_ATTRIBUTES = Object.freeze({}) as Readonly<Record<string, \"\">>;\n\n/**\n * Resolve the public reader-chrome option shape.\n *\n * `true` mirrors `ssg.readerChrome: true`: copy, outbound-link decoration, and\n * back-to-top are enabled. Object fields default on, so `{ copy: false }`\n * disables only the copy button.\n */\nexport function resolveReaderChromeInput(input: ReaderChromeInput = true): ResolvedReaderChrome {\n  if (!input) {\n    return false;\n  }\n  if (input === true) {\n    return { copy: true, externalLinks: true, backToTop: true };\n  }\n  return {\n    copy: input.copy ?? true,\n    externalLinks: input.externalLinks ?? true,\n    backToTop: input.backToTop ?? true,\n  };\n}\n\n/**\n * Apply the same native reader-chrome HTML transform used by the built-in SSG.\n *\n * This rewrites rendered article HTML. It wraps fenced `<pre>` blocks for copy\n * controls and decorates outbound links when enabled. Back-to-top remains a\n * document-shell control, so it is exposed through the asset helpers.\n */\nexport function applyReaderChromeHtml(html: string, input: ReaderChromeInput = true): string {\n  const chrome = resolveReaderChromeInput(input);\n  if (!chrome || (!chrome.copy && !chrome.externalLinks)) {\n    return html;\n  }\n  return importNapiModuleSync().applySsgReaderChromeHtml(html, {\n    copy: chrome.copy,\n    externalLinks: chrome.externalLinks,\n    backToTop: chrome.backToTop,\n  });\n}\n\n/**\n * Root attributes consumed by the browser runtime.\n */\nexport function readerChromeAttributes(\n  input: ReaderChromeInput = true,\n): Readonly<Record<string, \"\">> {\n  const chrome = resolveReaderChromeInput(input);\n  if (!readerChromeIsEnabled(chrome)) {\n    return EMPTY_ATTRIBUTES;\n  }\n\n  return {\n    \"data-ox-reader-chrome\": \"\",\n    ...(chrome.copy ? { \"data-ox-copy\": \"\" as const } : {}),\n    ...(chrome.externalLinks ? { \"data-ox-external-links\": \"\" as const } : {}),\n    ...(chrome.backToTop ? { \"data-ox-back-to-top\": \"\" as const } : {}),\n  };\n}\n\n/**\n * Render the root attributes as a leading-space HTML fragment.\n *\n * Useful in template strings: `<article${renderReaderChromeAttributes()}>`.\n */\nexport function renderReaderChromeAttributes(input: ReaderChromeInput = true): string {\n  return Object.keys(readerChromeAttributes(input))\n    .map((name) => ` ${name}`)\n    .join(\"\");\n}\n\n/**\n * CSS shared by the built-in SSG and custom hosts.\n */\nexport function readerChromeCss(input: ReaderChromeInput = true): string {\n  return readerChromeIsEnabled(resolveReaderChromeInput(input))\n    ? importNapiModuleSync().getSsgReaderChromeCss()\n    : \"\";\n}\n\n/**\n * Auto-initializing script shared by the built-in SSG and custom hosts.\n */\nexport function readerChromeScript(input: ReaderChromeInput = true): string {\n  return readerChromeNeedsJs(resolveReaderChromeInput(input))\n    ? importNapiModuleSync().getSsgReaderChromeScript()\n    : \"\";\n}\n\n/**\n * Inline stylesheet tag for hosts that do not import\n * `@ox-content/vite-plugin/styles/reader-chrome.css`.\n */\nexport function renderReaderChromeStyleTag(input: ReaderChromeInput = true): string {\n  const css = readerChromeCss(input);\n  return css ? `<style data-ox-style=\"reader-chrome\">\\n${css}</style>` : \"\";\n}\n\n/**\n * Inline auto-init script for static hosts that do not bundle\n * `@ox-content/vite-plugin/reader-chrome/client`.\n */\nexport function renderReaderChromeScriptTag(input: ReaderChromeInput = true): string {\n  const js = readerChromeScript(input);\n  return js ? `<script data-ox-script=\"reader-chrome\">\\n${js}</script>` : \"\";\n}\n\nexport function readerChromeIsEnabled(\n  chrome: ResolvedReaderChrome,\n): chrome is Exclude<ResolvedReaderChrome, false> {\n  return Boolean(chrome && (chrome.copy || chrome.externalLinks || chrome.backToTop));\n}\n\nexport function readerChromeNeedsJs(chrome: ResolvedReaderChrome): boolean {\n  return Boolean(chrome && (chrome.copy || chrome.backToTop));\n}\n"],"mappings":";;AASA,MAAM,mBAAmB,OAAO,OAAO,CAAC,CAAC;;;;;;;;AASzC,SAAgB,yBAAyB,QAA2B,MAA4B;CAC9F,IAAI,CAAC,OACH,OAAO;CAET,IAAI,UAAU,MACZ,OAAO;EAAE,MAAM;EAAM,eAAe;EAAM,WAAW;CAAK;CAE5D,OAAO;EACL,MAAM,MAAM,QAAQ;EACpB,eAAe,MAAM,iBAAiB;EACtC,WAAW,MAAM,aAAa;CAChC;AACF;;;;;;;;AASA,SAAgB,sBAAsB,MAAc,QAA2B,MAAc;CAC3F,MAAM,SAAS,yBAAyB,KAAK;CAC7C,IAAI,CAAC,UAAW,CAAC,OAAO,QAAQ,CAAC,OAAO,eACtC,OAAO;CAET,OAAO,qBAAqB,CAAC,CAAC,yBAAyB,MAAM;EAC3D,MAAM,OAAO;EACb,eAAe,OAAO;EACtB,WAAW,OAAO;CACpB,CAAC;AACH;;;;AAKA,SAAgB,uBACd,QAA2B,MACG;CAC9B,MAAM,SAAS,yBAAyB,KAAK;CAC7C,IAAI,CAAC,sBAAsB,MAAM,GAC/B,OAAO;CAGT,OAAO;EACL,yBAAyB;EACzB,GAAI,OAAO,OAAO,EAAE,gBAAgB,GAAY,IAAI,CAAC;EACrD,GAAI,OAAO,gBAAgB,EAAE,0BAA0B,GAAY,IAAI,CAAC;EACxE,GAAI,OAAO,YAAY,EAAE,uBAAuB,GAAY,IAAI,CAAC;CACnE;AACF;;;;;;AAOA,SAAgB,6BAA6B,QAA2B,MAAc;CACpF,OAAO,OAAO,KAAK,uBAAuB,KAAK,CAAC,CAAC,CAC9C,KAAK,SAAS,IAAI,MAAM,CAAC,CACzB,KAAK,EAAE;AACZ;;;;AAKA,SAAgB,gBAAgB,QAA2B,MAAc;CACvE,OAAO,sBAAsB,yBAAyB,KAAK,CAAC,IACxD,qBAAqB,CAAC,CAAC,sBAAsB,IAC7C;AACN;;;;AAKA,SAAgB,mBAAmB,QAA2B,MAAc;CAC1E,OAAO,oBAAoB,yBAAyB,KAAK,CAAC,IACtD,qBAAqB,CAAC,CAAC,yBAAyB,IAChD;AACN;;;;;AAMA,SAAgB,2BAA2B,QAA2B,MAAc;CAClF,MAAM,MAAM,gBAAgB,KAAK;CACjC,OAAO,MAAM,0CAA0C,IAAI,YAAY;AACzE;;;;;AAMA,SAAgB,4BAA4B,QAA2B,MAAc;CACnF,MAAM,KAAK,mBAAmB,KAAK;CACnC,OAAO,KAAK,4CAA4C,GAAG,cAAa;AAC1E;AAEA,SAAgB,sBACd,QACgD;CAChD,OAAO,QAAQ,WAAW,OAAO,QAAQ,OAAO,iBAAiB,OAAO,UAAU;AACpF;AAEA,SAAgB,oBAAoB,QAAuC;CACzE,OAAO,QAAQ,WAAW,OAAO,QAAQ,OAAO,UAAU;AAC5D"}

package/dist/styles/all.css

@@ -0,0 +1,15 @@
+@import "./core.css";
+@import "./magic-links.css";
+@import "./social.css";
+@import "./twitter-full.css";
+@import "./ogp.css";
+@import "./github.css";
+@import "./markdown-tables.css";
+@import "./youtube.css";
+@import "./tabs.css";
+@import "./mermaid.css";
+@import "./graphviz.css";
+@import "./citations.css";
+@import "./not-by-ai.css";
+@import "./reader-chrome.css";
+@import "./theme-transition.css";

package/dist/styles/citations.css

@@ -0,0 +1,62 @@
+.content .ox-cite {
+  white-space: nowrap;
+  font-size: 0.95em;
+}
+
+.content .ox-cite__ref {
+  font-variant-numeric: tabular-nums;
+  text-decoration-thickness: 0.08em;
+  text-underline-offset: 0.2em;
+}
+
+.content .ox-cite__ref:focus-visible,
+.content .ox-bibliography__item:focus-within {
+  outline: var(--octc-focus-ring);
+  outline-offset: var(--octc-focus-offset);
+}
+
+.content .ox-cite__ref:target,
+.content .ox-bibliography__item:target {
+  background: var(--octc-color-code-line-focus);
+}
+
+.content .ox-bibliography {
+  margin-top: 2rem;
+  padding-top: 1rem;
+  border-top: 1px solid var(--octc-color-border);
+}
+
+.content .ox-bibliography__title {
+  margin-top: 0;
+  font-size: 1.25rem;
+}
+
+.content .ox-bibliography__list {
+  margin-block: 0;
+  padding-inline-start: 1.5rem;
+}
+
+.content .ox-bibliography__item {
+  padding-inline-start: 0.25rem;
+  color: var(--octc-color-text-muted);
+}
+
+.content .ox-bibliography__item + .ox-bibliography__item {
+  margin-top: 0.65rem;
+}
+
+.content .ox-bibliography__item cite {
+  color: var(--octc-color-text);
+  font-style: italic;
+}
+
+.content .ox-bibliography__url,
+.content .ox-bibliography__doi {
+  overflow-wrap: anywhere;
+}
+
+@media print {
+  .content .ox-cite__ref {
+    text-decoration: none;
+  }
+}