@leuria/docusaurus 0.1.0

package/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

package/README.md

@@ -0,0 +1,19 @@
+# @leuria/docusaurus
+
+Ask AI for any Docusaurus site, on the reader's own AI: an assistant that answers from your docs with links to the pages. No API keys, nothing to pay per question.
+
+```sh
+npm install @leuria/docusaurus
+```
+
+```js
+// docusaurus.config.js
+plugins: [["@leuria/docusaurus", { suggestions: ["How do I get started?"] }]]
+```
+
+- **Ask AI** in the navbar: answers from your docs, knows the page the reader has open and the text they selected.
+- **Search** (`search: true`): ⌘K, by words at once and by meaning once the reader has an embedding model.
+- **WebMCP**: the same docs tools for the browser's own agents.
+- **Next to your search**: no theme component is replaced, so Algolia DocSearch and local search plugins keep working.
+
+Every option, and what readers see: [Ask AI for your Docusaurus site](../../docs/developers/docusaurus.md). Built on [`@leuria/docs`](../docs). Docusaurus 3.6+. Apache-2.0.

package/dist/client/index.d.ts

@@ -0,0 +1,22 @@
+import { Leuria } from '@leuria/client';
+import { Docs } from '@leuria/docs';
+
+/**
+ * The client module: starts Leuria in the browser once, and keeps the Ask
+ * panel and its conversation across the site's page changes. Nothing runs
+ * while Docusaurus renders pages at build time.
+ */
+
+/**
+ * The site's Leuria client and docs, once started in the browser (never
+ * during the build). For the site's own components:
+ *
+ *   import { leuria } from "@leuria/docusaurus/client"
+ *   const { ai } = await leuria
+ */
+declare const leuria: Promise<{
+    ai: Leuria;
+    docs: Docs;
+}>;
+
+export { leuria };

package/dist/client/index.js

@@ -0,0 +1,61 @@
+// src/client/index.ts
+import ExecutionEnvironment from "@docusaurus/ExecutionEnvironment";
+import config from "@leuria-docusaurus/config";
+import loadEmbedder from "@leuria-docusaurus/embedder";
+function navigate(url) {
+  const target = new URL(url, location.href);
+  if (target.origin !== location.origin) {
+    location.assign(target.href);
+    return;
+  }
+  if (target.pathname === location.pathname && target.search === location.search) {
+    location.hash = target.hash;
+    return;
+  }
+  history.pushState(null, "", `${target.pathname}${target.search}${target.hash}`);
+  dispatchEvent(new PopStateEvent("popstate", { state: null }));
+}
+function followTheme(setDefaultAppearance) {
+  const html = document.documentElement;
+  const apply = () => setDefaultAppearance(html.dataset.theme === "dark" ? "dark" : "light");
+  apply();
+  new MutationObserver(apply).observe(html, { attributes: true, attributeFilter: ["data-theme"] });
+}
+var started;
+var leuria = new Promise((resolve) => {
+  started = resolve;
+});
+async function start(settings) {
+  const [{ bridge, browserAI, createLeuria, server }, { setDefaultAppearance, setDefaultClient }, { createDocs, setupDocs }] = await Promise.all([
+    import("@leuria/client"),
+    import("@leuria/connect"),
+    import("@leuria/docs")
+  ]);
+  const providers = [bridge({ app: settings.app, needs: settings.needs }), browserAI()];
+  if (loadEmbedder) providers.push(await loadEmbedder());
+  if (settings.server) providers.push(server({ url: settings.server.url }));
+  const ai = createLeuria({ providers, fallback: settings.fallback });
+  setDefaultClient(ai);
+  followTheme(setDefaultAppearance);
+  const docs = createDocs(ai, {
+    corpus: () => import("@leuria-docusaurus/corpus").then((m) => m.default),
+    navigate
+  });
+  setupDocs(docs, { title: settings.title, suggestions: settings.suggestions, system: settings.system });
+  started({ ai, docs });
+  if (settings.askButton === "floating") {
+    const button = document.createElement("leuria-ask-button");
+    button.setAttribute("floating", "");
+    document.body.append(button);
+  }
+  if (settings.webmcp) {
+    await docs.load();
+    docs.expose();
+  }
+}
+if (ExecutionEnvironment.canUseDOM) {
+  start(config).catch((error) => console.warn("[leuria] Ask AI could not start:", error));
+}
+export {
+  leuria
+};

package/dist/index.d.ts

@@ -0,0 +1,101 @@
+import { LoadContext, Plugin } from '@docusaurus/types';
+
+/**
+ * @leuria/docusaurus: Ask AI for any Docusaurus site, on the reader's own
+ * AI. The site holds no API keys and pays nothing per question.
+ *
+ *   // docusaurus.config.js
+ *   plugins: [["@leuria/docusaurus", { suggestions: ["How do I get started?"] }]]
+ *
+ * It adds an "Ask AI" button to the navbar, and a panel that answers from
+ * the site's docs with links to the pages. It works next to any search
+ * (Algolia DocSearch, local search): it replaces no theme component. Sites
+ * without a search can add Leuria's (`search: true`), by words and by meaning.
+ */
+
+interface Options {
+    /** The name Leuria shows when the reader connects the site. Default: the site's title. */
+    app?: string;
+    /** The name the assistant gives the docs. Default: the site's title. */
+    site?: string;
+    /** The Ask panel's title. Default "Ask the docs". */
+    title?: string;
+    /** Questions offered before the first one. */
+    suggestions?: string[];
+    /** Replaces the assistant's instructions. */
+    system?: string;
+    /**
+     * Where the Ask button goes: `navbar` (default), `floating` (bottom
+     * right), or `none` (you place `<leuria-ask-button>` yourself).
+     */
+    askButton?: "navbar" | "floating" | "none";
+    /**
+     * Add a search to the navbar (⌘K), by words and by meaning. For sites
+     * without one: leave it off next to Algolia DocSearch or a local search.
+     * Default false.
+     */
+    search?: boolean;
+    /** Also put the "Connect your AI" button in the navbar. Default false: the Ask panel offers it when needed. */
+    connectButton?: boolean;
+    /** Offer the docs tools to the browser's own agents (WebMCP). Default true. */
+    webmcp?: boolean;
+    /**
+     * A small embedding model in the page (`@leuria/web-embed`, about 40 MB,
+     * downloaded when the reader agrees) for readers whose AI can't embed.
+     * Its runtime comes from a CDN (jsDelivr) and the model from Hugging
+     * Face. Install `@leuria/web-embed` to use it. Default false.
+     */
+    pageEmbeddings?: boolean;
+    /**
+     * What the Ask panel needs, so Leuria recommends a model that fits and no
+     * bigger. Default `{ tools: true, effort: "light" }`: it searches and reads
+     * your pages, then answers.
+     */
+    needs?: {
+        tools?: boolean;
+        images?: boolean;
+        effort?: "light" | "standard" | "deep";
+        context?: number;
+    };
+    /** Your server as the last resort, for readers with no AI of their own. */
+    server?: {
+        url: string;
+    };
+    /**
+     * Readers without Leuria: `ask` (default) proposes Leuria first, and this
+     * browser's AI or your server answer only once the reader picks one (for
+     * the page); `auto` uses them at once.
+     */
+    fallback?: "ask" | "auto";
+    /** Only these docs plugin instances. Default: every one. */
+    docsPluginIds?: string[];
+}
+/** What the client module gets, as JSON. */
+interface ClientConfig {
+    app: string;
+    title?: string;
+    suggestions?: string[];
+    system?: string;
+    askButton: "navbar" | "floating" | "none";
+    webmcp: boolean;
+    server?: {
+        url: string;
+    };
+    fallback: "ask" | "auto";
+    needs: {
+        tools?: boolean;
+        images?: boolean;
+        effort?: "light" | "standard" | "deep";
+        context?: number;
+    };
+}
+declare function leuriaDocusaurus(context: LoadContext, options?: Options): Plugin;
+declare function validateOptions({ options }: {
+    options?: Options & {
+        id?: string;
+    };
+}): Options & {
+    id: string;
+};
+
+export { type ClientConfig, type Options, leuriaDocusaurus as default, validateOptions };

package/dist/index.js

@@ -0,0 +1,127 @@
+// src/index.ts
+import { mkdirSync, readFileSync, writeFileSync } from "fs";
+import { join } from "path";
+import { fileURLToPath } from "url";
+import { buildCorpus } from "@leuria/docs/build";
+var NAME = "@leuria/docusaurus";
+function docsPages(context, allContent, ids) {
+  const pages = [];
+  let defaultVersion;
+  const instances = allContent["docusaurus-plugin-content-docs"] ?? {};
+  for (const [id, content] of Object.entries(instances)) {
+    if (ids && !ids.includes(id)) continue;
+    const versions = content.loadedVersions ?? [];
+    const versioned = versions.length > 1;
+    for (const version of versions) {
+      if (versioned && version.isLast) defaultVersion ??= version.versionName;
+      for (const doc of version.docs) {
+        if (doc.unlisted || doc.draft) continue;
+        const file = doc.source.replace(/^@site\//, `${context.siteDir}/`);
+        let markdown;
+        try {
+          markdown = readFileSync(file, "utf8");
+        } catch {
+          continue;
+        }
+        pages.push({
+          url: doc.permalink,
+          title: doc.title,
+          description: doc.description,
+          markdown,
+          version: versioned ? version.versionName : void 0
+        });
+      }
+    }
+  }
+  return { pages, defaultVersion };
+}
+function addNavbarItems(context, items) {
+  const navbar = context.siteConfig.themeConfig.navbar;
+  if (!navbar) return;
+  navbar.items ??= [];
+  for (const item of items) {
+    if (!navbar.items.some((existing) => existing.value === item.value)) navbar.items.push(item);
+  }
+}
+function leuriaDocusaurus(context, options = {}) {
+  const dir = join(context.generatedFilesDir, "leuria");
+  const files = {
+    config: join(dir, "config.json"),
+    corpus: join(dir, "corpus.json"),
+    embedder: join(dir, "embedder.js")
+  };
+  const title = context.siteConfig.title;
+  const askButton = options.askButton ?? "navbar";
+  const config = {
+    app: options.app ?? title,
+    title: options.title,
+    suggestions: options.suggestions,
+    system: options.system,
+    askButton,
+    webmcp: options.webmcp ?? true,
+    server: options.server,
+    fallback: options.fallback ?? "ask",
+    needs: options.needs ?? { tools: true, effort: "light" }
+  };
+  mkdirSync(dir, { recursive: true });
+  writeFileSync(files.config, JSON.stringify(config));
+  writeFileSync(files.corpus, JSON.stringify({ pages: [], sections: [] }));
+  writeFileSync(
+    files.embedder,
+    options.pageEmbeddings ? `export default function load() { return import("@leuria/web-embed/cdn").then((m) => m.pageEmbedder()); }
+` : "export default null;\n"
+  );
+  const items = [];
+  if (options.search) items.push({ type: "html", position: "right", value: "<leuria-search-button></leuria-search-button>", className: "leuria-navbar-item" });
+  if (askButton === "navbar") items.push({ type: "html", position: "right", value: "<leuria-ask-button></leuria-ask-button>", className: "leuria-navbar-item" });
+  if (options.connectButton) {
+    items.push({ type: "html", position: "right", value: '<leuria-connect-button size="1" hide-byline></leuria-connect-button>', className: "leuria-navbar-item" });
+  }
+  addNavbarItems(context, items);
+  return {
+    name: NAME,
+    async allContentLoaded({ allContent }) {
+      const { pages, defaultVersion } = docsPages(context, allContent, options.docsPluginIds);
+      const corpus = buildCorpus(pages, { site: options.site ?? title, defaultVersion });
+      writeFileSync(files.corpus, JSON.stringify(corpus));
+    },
+    configureWebpack() {
+      return {
+        resolve: {
+          alias: {
+            "@leuria-docusaurus/config": files.config,
+            "@leuria-docusaurus/corpus": files.corpus,
+            "@leuria-docusaurus/embedder": files.embedder
+          }
+        }
+      };
+    },
+    getClientModules() {
+      return [fileURLToPath(new URL("./client/index.js", import.meta.url))];
+    },
+    injectHtmlTags() {
+      return {
+        headTags: [
+          {
+            tagName: "style",
+            innerHTML: ".leuria-navbar-item{display:inline-flex;align-items:center;padding:0 var(--ifm-navbar-item-padding-horizontal,.75rem)}leuria-ask{--leuria-ask-top:calc(var(--ifm-navbar-height,3.75rem) + 8px)}"
+          }
+        ]
+      };
+    }
+  };
+}
+function validateOptions({ options }) {
+  const value = options ?? {};
+  if (value.askButton && !["navbar", "floating", "none"].includes(value.askButton)) {
+    throw new Error(`${NAME}: askButton must be "navbar", "floating" or "none".`);
+  }
+  if (value.suggestions && !Array.isArray(value.suggestions)) throw new Error(`${NAME}: suggestions must be a list of questions.`);
+  if (value.server && typeof value.server.url !== "string") throw new Error(`${NAME}: server needs a url.`);
+  if (value.fallback && !["ask", "auto"].includes(value.fallback)) throw new Error(`${NAME}: fallback must be "ask" or "auto".`);
+  return { ...value, id: value.id ?? "default" };
+}
+export {
+  leuriaDocusaurus as default,
+  validateOptions
+};

package/package.json

@@ -0,0 +1,62 @@
+{
+  "name": "@leuria/docusaurus",
+  "version": "0.1.0",
+  "description": "Ask AI for any Docusaurus site, on the reader's own AI: no API keys, nothing to pay per question. Plus the Connect button and WebMCP tools for the browser's agents.",
+  "license": "Apache-2.0",
+  "type": "module",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/leur-ia/leuria.git",
+    "directory": "packages/docusaurus"
+  },
+  "homepage": "https://leuria.dev",
+  "keywords": [
+    "docusaurus",
+    "docusaurus-plugin",
+    "ai",
+    "ask-ai",
+    "search",
+    "webmcp"
+  ],
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "default": "./dist/index.js"
+    },
+    "./client": {
+      "types": "./dist/client/index.d.ts",
+      "default": "./dist/client/index.js"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@leuria/client": "^0.1.0",
+    "@leuria/connect": "^0.1.0",
+    "@leuria/docs": "^0.1.0"
+  },
+  "peerDependencies": {
+    "@docusaurus/core": "^3.6.0",
+    "@leuria/web-embed": "^0.1.0"
+  },
+  "peerDependenciesMeta": {
+    "@leuria/web-embed": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@docusaurus/types": "^3.10.2",
+    "@types/node": "^22.0.0",
+    "tsup": "^8.4.0",
+    "typescript": "^5.9.0",
+    "vitest": "^3.2.0"
+  },
+  "scripts": {
+    "build": "tsup",
+    "check": "tsc --noEmit",
+    "test": "vitest run"
+  }
+}