Product Logo

Live-Editor einrichten

So aktivierst du den Live-Editor. Damit bearbeitest du Seiten direkt im Browser, und jedes Speichern landet als Commit in deinem Repository. Wie der Editor arbeitet, erfährst du unter Live-Editor verstehen.

Voraussetzungen

  • easyWebsite ab Version 3.0.0 (CI-Komponente md-to-web@v4)
  • Ein Projekt auf gitlab.opencode.de. Ab Version 3.1.3 geht auch eine eigene GitLab-Instanz, siehe gitlab-url
  • Die Rolle Developer, Maintainer oder Owner im Projekt, auch über eine Gruppe vererbt

Easy Mode

Aktiviere den Editor in der .gitlab-ci.yml:

Nach dem nächsten Pipeline-Lauf erreichst du den Editor unter /preview/ deiner Webseite. Die Anmeldung läuft über dein openCode-Konto.

Parameter

ParameterDefaultBeschreibung
enable-live-editor"false"Fügt die Editor-Seite /preview/ und die Anmeldeseite /oauth2/callback/ hinzu
private-mode"false"Veröffentlicht nur den Editor, keine Inhaltsseiten. Schaltet den Editor automatisch ein
connected-repo$CI_PROJECT_URLRepository, das der Editor liest und beschreibt
editor-subpath""Ordner im Repository, auf den der Editor beschränkt ist. Leer bedeutet md-path
editor-branch$CI_DEFAULT_BRANCHBranch, den der Editor liest und beschreibt
gitlab-url""GitLab-Instanz für die Anmeldung. Sie muss connected-repo hosten. Leer bedeutet gitlab.opencode.de. Ab 3.1.3
gitlab-application-id""ID der OAuth-Anwendung auf dieser Instanz. Leer bedeutet die openCode-Anwendung. Ab 3.1.3
content-security-policy""Ersetzt die erzeugte Content Security Policy. Ab 3.1.3

Privater Modus

Mit private-mode: "true" baut die Pipeline keine Inhaltsseiten. Die Startseite zeigt nur eine Anmeldung, und lesen können ausschließlich angemeldete Projektmitglieder mit Developer-Rolle oder höher.

Developer Mode

Lege die Editor-Seite pages/preview.tsx an:

Lege die Anmeldeseite pages/oauth2/callback.tsx an:

Binde die Styles des Editors ein. Schreibe den Import in dieselbe CSS-Datei wie dein Theme, direkt darunter. Nur so erzeugt Tailwind die Klassen, die der Editor braucht:

Schalte in der next.config.mjs die Theme-Dateien für den Editor ein. Übergib dazu { enableLiveEditor: true } als zweites Argument:

Damit legt der Build die Stylesheets aller Themes unter public/themes/ ab. Der Editor braucht sie, wenn du in den Projekteinstellungen ein anderes Theme wählst.

Der Editor bringt sein eigenes Layout mit. Rendere /preview in der pages/_app.tsx deshalb mit LayoutProviders statt Layout:

CORS-Proxy

Bis Version 3.1.2 liefen Clone und Push über einen CORS-Proxy. Ab Version 3.1.3 lädt und speichert der Editor über die GitLab-API und braucht keinen Proxy mehr.

  • Easy Mode: Die CI-Komponente ignoriert den Parameter cors-proxy. Entferne ihn aus deiner .gitlab-ci.yml.
  • Developer Mode: EditorShell hat keine Prop corsProxy mehr. Entferne sie aus deiner pages/preview.tsx.

Ergebnis prüfen

Öffne /preview/, melde dich an und wähle eine Seite im Dateibaum. Ändere einen Satz und klicke auf Save. Im Repository erscheint ein neuer Commit, und die Pipeline veröffentlicht die Änderung.

Nächste Schritte