Remote-MDX

Rufe mit der Quelle mdxRemote() Markdown und MDX per HTTP aus einem GitHub-Repository oder von einer Raw-URL ab und rendere sie mit allen Blume-Komponenten.

Der integrierte mdxRemote()-Adapter ruft rohe .md/.mdx-Dateien per HTTP ab. Die Dateien ermittelst du entweder aus einem Unterverzeichnis eines GitHub-Repos (github) oder gibst sie explizit zu einer Raw-Basis-URL an (url + files):

import { defineConfig } from "blume";
import { filesystem, mdxRemote } from "blume/sources";

export default defineConfig({
  content: {
    sources: [
      filesystem({ root: "docs" }),
      // The docs/ subtree of acme/sdk, mounted under /sdk
      mdxRemote({
        prefix: "sdk",
        github: { owner: "acme", repo: "sdk", ref: "main", path: "docs" },
      }),
    ],
  },
});

Wenn du die Dateien selbst auflisten willst, lass url auf eine Raw-Basis-URL zeigen:

mdxRemote({
  prefix: "sdk",
  url: "https://raw.githubusercontent.com/acme/sdk/main/docs",
  files: ["intro.mdx", "guide.mdx"],
});

Das Token für ein privates Repo wird aus der Umgebungsvariable GITHUB_TOKEN gelesen. Der Adapter deklariert sie, deshalb warnen blume dev und blume build, wenn sie nicht gesetzt ist. Das Token landet nie direkt in deiner Konfiguration oder in der generierten Ausgabe. Es wird außerdem nur an GitHubs eigene Hosts (api.github.com, raw.githubusercontent.com) gesendet, niemals an eine eigene url-Basis. Ein öffentliches Repo funktioniert auch ohne Token.

Remote-Seiten werden vollständig als MDX mit allen Komponenten gerendert. Ihr Inhalt wird dafür in ein verstecktes Staging-Verzeichnis geschrieben und zusammen mit deinen lokalen Docs über Astro gerendert. So funktionieren Callouts, Tabs und alle anderen Blume-Komponenten weiterhin.

Wie bei jeder Remote-Quelle werden abgerufene Seiten für Offline-Builds zwischengespeichert und mit blume sync aktualisiert – siehe Caching und Offline-Builds.