Product Logo

Edit-Page-Link einrichten

So aktivierst du den „Seite bearbeiten"-Link, der Besucher:innen direkt zur Quelldatei im Repository führt.

Developer Mode

Konfiguriere den editPage-Block in der theme.config.tsx:

Parameter

EigenschaftTypErforderlichDefaultBeschreibung
enabledbooleanfalseLink aktivieren
repoBaseUrlstring""Basis-URL, an die der Dateipfad angehängt wird
descriptionstring"Diese Seite bearbeiten"Angezeigter Linktext
icon"auto" | "edit" | "github" | "opencode" | "gitlab" | "none""auto"Icon neben dem Link

URL-Aufbau

Der Link wird durch einfache Konkatenation gebildet:

{repoBaseUrl}/{Dateipfad}

Der Dateipfad enthält den Pfad inklusive pages/-Präfix (z. B. pages/how-to-guides/edit-page-link.mdx). Damit der Link direkt zum Editor führt, muss repoBaseUrl den passenden Edit-Pfad enthalten:

PlattformrepoBaseUrl
GitLabhttps://gitlab.example.com/org/repo/-/edit/main
GitHubhttps://github.com/org/repo/edit/main

Verfügbare Icons

WertBeschreibung
autoErkennt die Plattform anhand der Teilstrings gitlab, github, opencode in der URL — fällt auf edit zurück, wenn keiner passt
editGenerisches Bearbeiten-Icon (Stift)
githubGitHub-Icon
gitlabGitLab-Icon
opencodeopenCode-Icon
noneKein Icon

Ergebnis

Im Inhaltsverzeichnis (TOC) jeder Seite erscheint ein Link, der zur entsprechenden Quelldatei im Repository führt.