From 98c639303432f9e3bb8e0193bb4b121f32a991d9 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Sun, 20 Apr 2025 12:40:07 +0200 Subject: [PATCH 01/11] feat: update contributing --- .../contributing/code-contributions.mdx | 2 +- .../guides/contributing/getting-started.mdx | 2 +- .../de/guides/contributing/translations.mdx | 106 ++++++++++++++++-- 3 files changed, 98 insertions(+), 12 deletions(-) diff --git a/src/content/docs/de/guides/contributing/code-contributions.mdx b/src/content/docs/de/guides/contributing/code-contributions.mdx index cd6df0be..8196448e 100644 --- a/src/content/docs/de/guides/contributing/code-contributions.mdx +++ b/src/content/docs/de/guides/contributing/code-contributions.mdx @@ -1,7 +1,7 @@ --- i18nReady: true title: Code-Beiträge -description: Erfahre, wie du zu StudioCMS beitragen kannst +description: Erfahre, wie du Code zu StudioCMS beitragen kannst sidebar: order: 2 --- diff --git a/src/content/docs/de/guides/contributing/getting-started.mdx b/src/content/docs/de/guides/contributing/getting-started.mdx index 9d4ad2e0..eea17a61 100644 --- a/src/content/docs/de/guides/contributing/getting-started.mdx +++ b/src/content/docs/de/guides/contributing/getting-started.mdx @@ -1,7 +1,7 @@ --- i18nReady: true title: Erste Schritte -description: Erfahre, wie du zu StudioCMS beitragen kannst +description: Lerne die Grundlagen der Mitwirkung in StudioCMS sidebar: order: 1 --- diff --git a/src/content/docs/de/guides/contributing/translations.mdx b/src/content/docs/de/guides/contributing/translations.mdx index 018792d6..e08d4454 100644 --- a/src/content/docs/de/guides/contributing/translations.mdx +++ b/src/content/docs/de/guides/contributing/translations.mdx @@ -1,34 +1,120 @@ --- i18nReady: true title: Übersetzungen -description: Erfahre, wie du bei der Übersetzung von StudioCMS helfen kannst +description: Erfahre, wie du Übersetzungen zu StudioCMS beisteuern kannst sidebar: order: 2 badge: - text: Demnächst - variant: note + text: Aktualisiert + variant: success --- import ReadMore from '~/components/ReadMore.astro'; +import { FileTree } from '@astrojs/starlight/components'; StudioCMS ist ein globales Projekt, und wir wollen es für alle zugänglich machen. Wenn du mehrere Sprachen fließend beherrschst, kannst du uns helfen, StudioCMS in deine Sprache zu übersetzen. -## Dashboard-i18n +## Mach mit auf Discord -Aktueller Stand der Übersetzung +Bevor du dich ins Übersetzen stürzt, schau in unserem [Discord-Chat](https://chat.studiocms.dev) vorbei. + +Auf Discord bekommst du Antworten in Echtzeit und kannst dich mit anderen Übersetzerinnen und Übersetzern abstimmen, damit niemand unwissentlich auf der gleichen Seite arbeitet. Außerdem finden dort alle unsere i18n-Diskussionen und Stiltipps statt, was es zur ersten Anlaufstelle macht, um sich über bewährte Verfahren zu informieren und an Entscheidungen beteiligt zu werden. + +:::tip[Du kannst nicht auf Discord zugreifen?] +Wir wollen, dass du trotzdem mitmachst! Bitte eröffne ein neues Issue auf GitHub für [Docs](https://github.com/withstudiocms/docs/issues/new/choose) oder die [Pakete](https://github.com/withstudiocms/studiocms/issues/new/choose), um deine Fragen zu stellen. +::: + +## Übersetzungen der Pakete + +Aktueller Stand der Übersetzung: Status der Übersetzung -Besuche [unser i18n-Dashboard](https://i18n.studiocms.dev), um die Übersetzung von StudioCMS in deine Sprache zu unterstützen. Wenn deine Sprache nicht aufgeführt ist, kannst du sie im Dashboard hinzufügen. +Besuche [unser i18n-Dashboard](https://i18n.studiocms.dev), um bei der Übersetzung der StudioCMS-Pakete in deine Sprache zu helfen. Wenn deine Sprache nicht aufgeführt ist, kannst du sie im Dashboard hinzufügen. -Wenn du die Übersetzungen lieber direkt in das Repository einbringen möchtest, werden sie im Verzeichnis [`packages/studiocms/src/lib/i18n/translations`](https://github.com/withstudiocms/studiocms/tree/main/packages/studiocms/src/lib/i18n/translations/) gespeichert. Die englischen Übersetzungen findest du in der Datei [`en-us.json`](https://github.com/withstudiocms/studiocms/blob/main/packages/studiocms/src/lib/i18n/translations/en-us.json). +Wenn du die Übersetzungen lieber direkt in das Repository einbringen möchtest, werden sie im Verzeichnis [`packages/studiocms/src/lib/i18n/translations`](https://github.com/withstudiocms/studiocms/tree/main/packages/studiocms/src/lib/i18n/translations/) gespeichert. Die englischen Übersetzungen findest du in der Datei [`en.json`](https://github.com/withstudiocms/studiocms/blob/main/packages/studiocms/src/lib/i18n/translations/en.json). + +Egal, wo du übersetzt (Crowdin oder GitHub), die Informationen werden automatisch synchronisiert und sind in der nächsten Version verfügbar. -StudioCMS nutzt [Crowdin](https://crowdin.com/) für die Verwaltung von Übersetzungen auf GitHub. Wenn du Crowdin noch nicht kennst, findest du auf der Website von Crowdin den [Leitfaden für Übersetzer](https://support.crowdin.com/for-translators/). +Alle StudioCMS-Pakete nutzen [Crowdin](https://crowdin.com/) für die Verwaltung von Übersetzungen auf GitHub. Wenn du Crowdin noch nicht kennst, findest du die [Anleitung für Übersetzer](https://support.crowdin.com/for-translators/) auf der Website von Crowdin. Sobald die Übersetzungen hinzugefügt wurden, werden sie zur [StudioCMS i18n-Konfiguration](https://github.com/withstudiocms/studiocms/blob/main/packages/studiocms/src/lib/i18n/index.ts#L8) hinzugefügt und sind in der nächsten Version verfügbar. -## Dokumentation +## Übersetzung der Dokumentation + +StudioCMS arbeitet aktiv daran, seine Dokumentation in mehrere Sprachen zu übersetzen. + +Zurzeit versuchen wir, die StudioCMS-Dokumentation in die folgenden Sprachen zu übersetzen: + +- Spanisch +- Französisch +- Deutsch +- Koreanisch + +Ein großes Lob an unsere großartigen Übersetzerinnen und Übersetzer in der Community, die ihre Zeit opfern, um unsere Website in den oben genannten Sprachen verfügbar zu machen. Wir würden gerne jede Sprache unterstützen, aber wir müssen uns auf die Sprachen konzentrieren, für die wir bereits Leute haben, die bereit sind, zu übersetzen und die Dinge auf dem neuesten Stand zu halten. Wenn wir eine neue Sprache einführen, müssen wir ein Team zusammenstellen und mit mehreren Codebasen jonglieren. Deshalb führen wir nur solche Sprachen ein, die wir vorher genehmigt haben und für die wir bereits ein Team haben, das die Übersetzung der gesamten Seite in Angriff nimmt. + +### Erste Schritte + +Schau bei unserem [Übersetzungs-Tracker](https://i18n.docs.studiocms.dev) vorbei, um den Live-Status jeder Seite zu sehen - was aktuell ist, was überarbeitet werden muss und welche PRs noch auf eine Überprüfung warten. Er zieht unsere lokale Git-Historie heran, um die Zeitstempel aller Übersetzungen zu vergleichen und den Status jeder Seite automatisch zu aktualisieren. + +Du kannst auch direkt in GitHub einsteigen: Filtere die offenen PRs deiner Sprache nach dem i18n-Label, suche nach Tippfehlern oder Fehlübersetzungen und gib ihnen eine Bewertung. Das ist eine tolle Möglichkeit, um herauszufinden, wie StudioCMS mit i18n umgeht! + +### Aufbau der Dokumentation + +Das docs-Repository enthält drei verschiedene Arten von übersetzbaren Inhalten: docs-Seiten und UI-Strings. Der folgende Dateibaum zeigt, wo diese im Repository zu finden sind. + + + +- ... +- src/ + - ... + - content/ + - docs/ MDX-Seiteninhalt, ein Verzeichnis pro Sprache + - de/ + - en/ + - es/ + - ... + - i18n/ UI-String-Übersetzungen, eine Datei pro Sprache + - de.json + - en.json + - es.json + - ... + - starlight-sidebar/ UI-String-Übersetzungen für die Sidebar, eine Datei pro Sprache + - de.json + - en.json + - es.json + - ... +- astro.config.ts +- package.json +- ... + + + +### Übersetzungsprozess + +Bereit zum Eintauchen? Hier erfährst du, wie du im Repo findest, was du brauchst: + +1. **Seitenspezifischer Inhalt** (Seitentitel, Haupttext, usw.) + + ➤ Gehe zu `src/content/docs/{language}/{page-slug}.mdx` + +2. **Gemeinsamer Text** (Suchmodal, rechte Seitenleiste, Links zum „nächsten Artikel“, Tutorials usw.) + + ➤ Gehe zu `src/content/i18n/{language}.json` + +3. **Primäre Seitenleistenübersetzungen** + + ➤ Gehe zu `src/starlight-sidebar/{language}.json` + + +Wenn du deine Zieldatei gefunden hast, sieh dir den [Übersetzungs-Tracker](https://i18n.docs.studiocms.dev/) und bestehende PRs an, vielleicht arbeitet ja schon jemand daran. Wenn du Zeit hast, melde dich im `docs-i18n`-Kanal in Discord, damit niemand doppelte Arbeit macht! + +:::note +Bist du dir nicht sicher, ob etwas übersetzt werden sollte oder nicht? Wie funktioniert eine bestimmte Komponente? Schau in unsere [Referenz](/de/config-reference/). +::: -**Bald!** Wir arbeiten daran, die StudioCMS-Dokumentation zu übersetzen. Wenn du daran interessiert bist, uns dabei zu helfen, melde dich bitte bei uns auf [Discord](https://chat.studiocms.dev) +:::caution +Nicht alle unsere Seiten sind übersetzungsreif. Wir geben neue Seiten je nach ihrer Stabilität zur Übersetzung frei, also übersetze keine Seiten, die keinen „Diese Seite übersetzen“-Button im Bereich „Beitragen“ in der rechten Seitenleiste haben. +::: From 049a6ca98a848781a48447a77a5765895e46baec Mon Sep 17 00:00:00 2001 From: trueberryless Date: Sun, 20 Apr 2025 12:51:30 +0200 Subject: [PATCH 02/11] feat: translate sqld --- .../docs/de/guides/database/sqld-server.mdx | 157 ++++++++++++++++++ 1 file changed, 157 insertions(+) create mode 100644 src/content/docs/de/guides/database/sqld-server.mdx diff --git a/src/content/docs/de/guides/database/sqld-server.mdx b/src/content/docs/de/guides/database/sqld-server.mdx new file mode 100644 index 00000000..346540af --- /dev/null +++ b/src/content/docs/de/guides/database/sqld-server.mdx @@ -0,0 +1,157 @@ +--- +i18nReady: true +title: Selbstgehosteter libSQL-Server +description: Hoste deinen eigenen sqld libSQL Server mit Docker +--- + +import ReadMore from '~/components/ReadMore.astro' +import { PackageManagers } from 'starlight-package-managers' +import { FileTree, TabItem, Tabs, Steps, Aside } from '@astrojs/starlight/components'; + +Das Projekt `sqld` („SQL daemon“) ist ein Servermodus für libSQL, der von Turso entwickelt wurde. In diesem Leitfaden wird beschrieben, wie du `sqld` für dein StudioCMS-Projekt einrichtest und konfigurierst, damit es in einem Docker-Container funktioniert. + +Mehr über `sqld` erfährst du in deren [Dokumentation][sql-docs] + +## Voraussetzungen + +- [Docker und Docker Compose][docker-docs] (entweder auf einem Server oder lokal ausgeführt) +- [OpenSSL][openssl-docs] installiert +- StudioCMS CLI (verfügbar im Stammverzeichnis deines StudioCMS-Projekts) + +Die endgültige Dateistruktur wird etwa so aussehen, wenn du lokal testest: + + + +- docker-compose.yml +- data/ +- keys/ +- mein-studiocms-project/ + - astro.config.mjs + - studiocms.config.mjs + - package.json + - src/ + + + +## Private und öffentliche Schlüssel generieren + +Führe im Verzeichnis `keys` den folgenden Befehl aus, um ein neues PKCS#8-kodiertes Ed25519-Schlüsselpaar zu erstellen: + +```bash +openssl genpkey -algorithm Ed25519 -out ./libsql.pem +``` + +Dann extrahiere den öffentlichen Schlüssel mit: + +```bash +openssl pkey -in ./libsql.pem -pubout -out ./libsql.pub +``` + +Dadurch wird ein neues PKCS#8-Schlüsselpaar erzeugt, das für den `sqld`-Server verwendet wird. + +## Erstelle dein JWT-Token + +Navigiere zu deinem studiocms-Projektverzeichnis und führe den folgenden Befehl aus: + + + +Die Ausgabe ist das mit deinem privaten Schlüssel verschlüsselte JWT-Auth-Token, das für die libSQL-Authentifizierung verwendet wird. Beachte, dass das Token 1 Jahr lang gültig ist! + +### Aktualisiere deine StudioCMS `.env` mit den folgenden Angaben: + +```sh +ASTRO_DB_REMOTE_URL=http://localhost:8080 # Dies sollte auf deinen Docker-Server/dein lokales System zeigen +ASTRO_DB_APP_TOKEN= # füge hier dein base64URL kodiertes JWT Auth-Token ein +``` + +## Einrichten des Docker-Containers + +Erstelle eine neue Datei `docker-compose.yml` außerhalb des StudioCMS-Projektverzeichnisses für die libSQL-Instanz. An dieser Stelle hast du zwei Möglichkeiten, die libSQL-Authentifizierung zu konfigurieren: + +- Verwendung der öffentlichen Schlüsseldatei selbst +- Verwendung des JWT-Tokens als Umgebungsvariable (derselbe ASTRO_DB_APP_TOKEN-Wert, den du in deiner .env-Datei verwendet hast) + + + + + +```yml +services: + libsql: + image: ghcr.io/tursodatabase/libsql-server:latest + platform: linux/amd64 + ports: + - "8080:8080" + - "5001:5001" + environment: + - SQLD_NODE=primary + - SQLD_AUTH_JWT_KEY_FILE=/home/.ssh/libsql.pub + volumes: + - ./data/libsql:/var/lib/sqld + - ./keys/libsql.pub:/home/.ssh/libsql.pub +``` + + + + + +```yml +services: + libsql: + image: ghcr.io/tursodatabase/libsql-server:latest + platform: linux/amd64 + ports: + - "8080:8080" + - "5001:5001" + environment: + - SQLD_NODE=primary + - SQLD_AUTH_JWT_KEY=füge dein JWT-Token hier ein + volumes: + - ./data/libsql:/var/lib/sqld +``` + + + + + + + +## Alles in Gang setzen + + + +1. Starte den Docker Container + + Führen Sie im Basisverzeichnis (oder auf dem Server, wenn Sie diesen Weg gewählt haben) den folgenden Befehl aus, um den libSQL Server Container zu starten: + + ```sh + docker compose up -d + ``` + +2. Synchronisiere dein StudioCMS-Datenbankschema: + + Wechsle in dein StudioCMS-Projektverzeichnis und führe den folgenden Befehl aus: + + + +3. Folge der Ersteinrichtung für deine neue Datenbank. + + - Siehe [Erste Schritte][getting-started] + + :::note + Wenn dies nicht das erste Mal ist, dass du ein StudioCMS-Projekt einrichtest, musst du eventuell die Option `dbStartPage` in deiner `studiocms.config.mjs` aktivieren + ::: + + + +## Abschließende Überlegungen + +Wenn du nach einer Möglichkeit suchst, deine eigene libSQL-Datenbank mit StudioCMS zu hosten, ist `sqld` eine praktikable Option und nicht sehr kompliziert, wenn du es richtig machst. Wenn du diese Anleitung befolgst, erhältst du einen sicheren libSQL-Server, den du neben deinem StudioCMS-Projekt verwenden kannst + +{/* Links */} +[sql-docs]: https://github.com/tursodatabase/libsql/blob/main/docs/USER_GUIDE.md +[docker-docs]: https://docs.docker.com/get-started/get-docker/ +[openssl-docs]: https://docs.openssl.org/3.2/man7/ossl-guide-introduction/#getting-and-installing-openssl +[getting-started]: /de/start-here/getting-started/#erstmalige-einrichtung-oder-bei-aktualisierungen-wenn-das-tabellenschema-aktualisiert-wird \ No newline at end of file From fd20b62c9076589dfc83c0148e853898b5e1606d Mon Sep 17 00:00:00 2001 From: trueberryless Date: Sun, 20 Apr 2025 13:20:07 +0200 Subject: [PATCH 03/11] feat: translate guides/index --- src/content/docs/de/guides/index.mdx | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) create mode 100644 src/content/docs/de/guides/index.mdx diff --git a/src/content/docs/de/guides/index.mdx b/src/content/docs/de/guides/index.mdx new file mode 100644 index 00000000..cd963d2a --- /dev/null +++ b/src/content/docs/de/guides/index.mdx @@ -0,0 +1,20 @@ +--- +i18nReady: true +title: Leitfäden & Tutorials +description: Leitfäden und Tutorials für StudioCMS +--- + +## Leitfäden zum Beitragen + +- [Erste Schritte](/de/guides/contributing/getting-started/) - Erfahre die Grundlagen des Beitragens zu StudioCMS +- [Codebeiträge](/de/guides/contributing/code-contributions/) - Erfahre, wie du Code zu StudioCMS beisteuern kannst +- [Übersetzungen](/de/guides/contributing/translations/) - Erfahre, wie du Übersetzungen zu StudioCMS beisteuern kannst + +## Upgrade Guides + +- [Anmerkungen zu Releases](/de/guides/upgrade/release-notes/) - Automatisierte Anmerkungen zu Releases, die aus den StudioCMS Changelogs generiert werden +- In der Seitenleiste findest du weitere Optionen für diese Kategorie, wie z.B. die spezifischen Versionsanleitungen. + +## Datenbanken + +- [Selbstgehosteter libSQL-Server](/de/guides/database/sqld-server/) - Hoste deinen eigenen sqld libSQL Server mit Docker From e57cdd573b055165ad7304957db8a9770f165421 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Sun, 20 Apr 2025 13:29:47 +0200 Subject: [PATCH 04/11] docs: translate version-guide --- .../upgrade/version-guides/0-1-0-beta-16.mdx | 35 +++++++++++++++++++ 1 file changed, 35 insertions(+) create mode 100644 src/content/docs/de/guides/upgrade/version-guides/0-1-0-beta-16.mdx diff --git a/src/content/docs/de/guides/upgrade/version-guides/0-1-0-beta-16.mdx b/src/content/docs/de/guides/upgrade/version-guides/0-1-0-beta-16.mdx new file mode 100644 index 00000000..295ec50d --- /dev/null +++ b/src/content/docs/de/guides/upgrade/version-guides/0-1-0-beta-16.mdx @@ -0,0 +1,35 @@ +--- +i18nReady: true +title: "Aktualisieren: 0.1.0-beta.16" +description: Aktualisiere StudioCMS auf Beta.16 +sidebar: + label: 0.1.0-beta.16 + badge: + text: NEU + variant: success + order: 999999 +--- + +import ReadMore from '~/components/ReadMore.astro' +import QuickUpdate from '~/components/QuickUpdate.astro' + + + +## Bahnbrechende Veränderungen + +- Aktualisierte Mindestversion von Astro auf `Astro v5.7.1` +- Aktualisierte Passwortsicherheit + - Die Benutzer/innen sollten angewiesen werden, ihre Passwörter nach der Aktualisierung zu aktualisieren, da die Unterstützung für das Hashing von alten Passwörtern in Zukunft entfernt wird. + +## Neue Merkmale/Funktionalität + +- CLI Aktualisierungen/Änderungen + - Neuer Befehl: `studiocms add ` zum schnellen Hinzufügen neuer Plugins zu deinem StudioCMS-Projekt. + - Neuer Befehl: `studiocms crypto [command]` für neue Sicherheitsprogramme. + - Neuer Befehl: `studiocms crypto gen-jwt ` zum Erzeugen von JWT-Tokens über die CLI. + - Fix: Die Bearbeitung von Nutzern über die CLI ist jetzt dank des neuen partiellen db drizzle Schemas für Nutzer und Berechtigungen möglich. + +Weitere Informationen über die neuen CLI-Befehle findest du in der Dokumentation [Das CLI][cli-docs] + +{/* Links */} +[cli-docs]: /de/how-it-works/cli/ From 53910a74ee58ba6efa9b8f9383ed57a3fd21b0ab Mon Sep 17 00:00:00 2001 From: trueberryless Date: Sun, 20 Apr 2025 17:30:39 +0200 Subject: [PATCH 05/11] docs: update dictionaries --- src/content/i18n/de.json | 3 ++- src/starlight-sidebar/de.json | 7 ++++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/src/content/i18n/de.json b/src/content/i18n/de.json index 78ec2eb8..0111989f 100644 --- a/src/content/i18n/de.json +++ b/src/content/i18n/de.json @@ -44,5 +44,6 @@ "docsearch.noResultsScreen.noResultsText": "Keine Ergebnisse für", "docsearch.noResultsScreen.suggestedQueryText": "Versuche die Suche nach", "docsearch.noResultsScreen.reportMissingResultsText": "Glaubst du, dass diese Abfrage Ergebnisse liefern sollte?", - "docsearch.noResultsScreen.reportMissingResultsLinkText": "Lass es uns wissen." + "docsearch.noResultsScreen.reportMissingResultsLinkText": "Lass es uns wissen.", + "quick-update": "Aktualisiere schnell auf die neueste Version, indem du den folgenden Befehl ausführst" } diff --git a/src/starlight-sidebar/de.json b/src/starlight-sidebar/de.json index 20e02a0d..c995c970 100644 --- a/src/starlight-sidebar/de.json +++ b/src/starlight-sidebar/de.json @@ -12,5 +12,10 @@ "community-plugins": "Community-Plugins", "config-reference": "Konfigurationsreferenz", "typedoc": "TypeDoc", - "auto-gen": "Automatisch generiert" + "auto-gen": "Automatisch generiert", + "topic-guides": "Leitfäden & Tutorials", + "database": "Datenbank-Leitfäden", + "upgrade": "Aktualisieren", + "version": "Anleitungen zu Versionen", + "latest": "Neuerste Aktualisierungs-Anleitung" } From 76145802e0de054cf3ab8a8b50570cfce8626507 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Sun, 20 Apr 2025 20:52:20 +0200 Subject: [PATCH 06/11] docs: update cli --- src/content/docs/de/how-it-works/cli.mdx | 320 ++++++++++++++++------- 1 file changed, 220 insertions(+), 100 deletions(-) diff --git a/src/content/docs/de/how-it-works/cli.mdx b/src/content/docs/de/how-it-works/cli.mdx index 91f1efc4..ecd5c01a 100644 --- a/src/content/docs/de/how-it-works/cli.mdx +++ b/src/content/docs/de/how-it-works/cli.mdx @@ -4,92 +4,120 @@ title: "Das CLI" description: "Erfahre mehr über die StudioCMS CLIs und wie du sie benutzt." sidebar: order: 2 + badge: + text: 'Aktualisiert' + variant: 'success' +tableOfContents: + minHeadingLevel: 2 + maxHeadingLevel: 4 --- import { Tabs, TabItem } from '@astrojs/starlight/components'; import ReadMore from '~/components/ReadMore.astro'; -# Einführung - Die StudioCMS CLIs sind Dienstprogramme, mit denen du schnell neue StudioCMS-Projekte einrichten und nützliche Dienstprogramme für StudioCMS bereitstellen kannst. -There is two different CLIs that are part of the StudioCMS ecosystem: -- **`create-studiocms`**: Das StudioCMS-Projektgerüst CLI. -- **`studiocms`**: Das StudioCMS Dienstprogramm CLI. +Es gibt mehrere verschiedene CLIs, die Teil des StudioCMS-Ökosystems sind: + +- **[`studiocms`](#studiocms)**: Das StudioCMS-Dienstprogramm CLI. +- **[`create-studiocms`](#create-studiocms)**: Das StudioCMS Projektgerüst CLI. +- **[`@studiocms/upgrade`](#studiocms-upgrade)**: Upgrade von StudioCMS-Projekten und ihren Plugins. Im Folgenden findest du eine Übersicht über die StudioCMS CLI und ihre Komponenten. -## `create-studiocms` +## `studiocms` -### Installation +### Vollständige CLI Optionen und Befehle - - - ```sh - npm create studiocms@latest - ``` - - - ```sh - pnpm create studiocms - ``` - - - ```sh - yarn create studiocms - ``` - - +```log +Usage: studiocms [options] [command] -`create-studiocms` läuft automatisch im _interaktiven_ Modus, aber du kannst deinen Projektnamen und deine Vorlage auch mit Kommandozeilenargumenten angeben. +Options: + -V, --version Output the current version of the CLI Toolkit. + -h, --help display help for command + --color force color output + --no-color disable color output + +Commands: + add Add StudioCMS plugin(s) to your project + crypto Crypto Utilities for Security + get-turso Install the Turso CLI + init Initialize the StudioCMS project after new installation. + users Utilities for Tweaking Users in StudioCMS +``` + +### Beispiel für die Verwendung + +Von deinem StudioCMS-Projektstammverzeichnis aus: ```sh - npm create studiocms@latest -- --template studiocms/basics --project-name my-studiocms-project + npm run studiocms [command] ``` ```sh - pnpm create studiocms --template studiocms/basics --project-name my-studiocms-project + pnpm studiocms [command] ``` ```sh - yarn create studiocms --template studiocms/basics --project-name my-studiocms-project + yarn studiocms [command] ``` -[Eine vollständige Liste][templates] findest du auf GitHub. +### Aufschlüsselung der Befehle -Wenn du `--template` verwendest, durchsucht das CLI das Vorlagen-Repository nach allen Ordnern. Die Vorlage `studiocms/basics` verweist zum Beispiel auf das Projekt `basics` im Ordner `studiocms` im Stammverzeichnis des Repositorys. +#### `add` -### Vollständige CLI Optionen und Befehle +```log +usage: studiocms add + +Adds StudioCMS plugin(s) to your project. + +Arguments: + plugins Plugin(s) to install + +Options: + -h, --help display help for command +``` -#### Haupteinstiegspunkt +#### `crypto` ```log -Usage: create-studiocms [options] [command] +usage: studiocms crypto [command] + +Crypto Utilities for Security Options: - -V, --version Output the current version of the CLI Toolkit. - -h, --help display help for command - --color force color output - --no-color disable color output + -h, --help display help for command Commands: - get-turso Get the latest version of Turso. - help Show help for command - interactive* Start the interactive CLI. + gen-jwt Generate JWT token from a keyfile +``` - * Indicates the default command that is run when calling this CLI. +#### `crypto gen-jwt` + +```log +usage: studiocms crypto gen-jwt [options] + +Generate a JWT token from a keyfile + +Arguments: + key-file a relative path (e.g., `../keys/libsql.pem`) from the current directory to your private key file (.pem) + +Options: + -c, --claim claim in the form [key=value] + -e, --exp Expiry date in seconds (>=0) from issued at (iat) time + -h, --help display help for command ``` #### `get-turso` -Du kannst die neueste Version von Turso herunterladen und installieren, indem du das Skript aus -Turso's [Dokumentation](https://docs.turso.tech/cli/installation). +Lädt die neueste Version von Turso herunter und installiert sie mit dem Skript aus +Turso's [Dokumentation][turso-docs]. :::note Windows erfordert die Verwendung von WSL wie bei Turso @@ -104,6 +132,112 @@ Options: -h, --help display help for command ``` +#### `init` + +```log +Usage: studiocms init [options] + +Initialize the StudioCMS project after new installation. + +Options: + -d, --dry-run Dry run mode + --skip-banners Skip all banners + --debug Enable debug mode + -h, --help Display help for command +``` + +Der init-Befehl bietet eine interaktive Einrichtungsmöglichkeit, die dir hilft: + +1. Richte deine Umgebungsdatei (.env) mit den folgenden Optionen ein: + - eine Beispiel-`.env`-Vorlage zu verwenden + - den interaktiven `.env`-Builder zu verwenden, mit dem du: + - Eine neue Turso-Datenbank einrichten (wenn nicht unter Windows) + - OAuth-Anbieter konfigurieren (GitHub, Discord, Google, Auth0) + - Verschlüsselungsschlüssel und andere erforderliche Variablen setzen + - Die Erstellung von Umgebungsdateien überspringen + +2. Der Befehl beinhaltet die automatische Turso CLI-Installation und die Authentifizierung, falls dies beim Einrichten einer Datenbank erforderlich ist. + +Eine vollständige Liste der Umgebungsvariablen findest du in der [Dokumentation Umgebungsvariablen][environment-variables]. + +#### `users` + +```log +usage: studiocms users [options] + +Utilities for Tweaking Users in StudioCMS + +Options: + -h, --help display help for command +``` + +## `create-studiocms` + +### Vollständige CLI Optionen und Befehle + +```log +Usage: create-studiocms [options] [command] + +Options: + -V, --version Output the current version of the CLI Toolkit. + -h, --help display help for command + --color force color output + --no-color disable color output + +Commands: + get-turso Get the latest version of Turso. + help Show help for command + interactive* Start the interactive CLI. + + * Indicates the default command that is run when calling this CLI. +``` + +### Beispiel für die Verwendung + + + + ```sh + npm create studiocms@latest + ``` + + + ```sh + pnpm create studiocms + ``` + + + ```sh + yarn create studiocms + ``` + + + +`create-studiocms` läuft automatisch im _interaktiven_ Modus, aber du kannst deinen Projektnamen und deine Vorlage auch mit Kommandozeilenargumenten angeben. + + + + ```sh + npm create studiocms@latest -- --template studiocms/basics --project-name my-studiocms-project + ``` + + + ```sh + pnpm create studiocms --template studiocms/basics --project-name my-studiocms-project + ``` + + + ```sh + yarn create studiocms --template studiocms/basics --project-name my-studiocms-project + ``` + + + +[Eine vollständige Liste][templates] findest du auf GitHub. + +Wenn du `--template` verwendest, durchsucht das CLI das Vorlagen-Repository nach allen Ordnern. Die Vorlage `studiocms/basics` verweist zum Beispiel auf das Projekt `basics` im Ordner `studiocms` im Stammverzeichnis des Repositorys. + +### Aufschlüsselung der Befehle + #### Interaktiv (Standardbefehl) ```log @@ -130,31 +264,10 @@ Options: --do-not-init-git Do not initializing a git repository. ``` -## `studiocms` - -### Vollständige CLI Optionen und Befehle - -#### Haupteinstiegspunkt - -```log -Usage: studiocms [options] [command] - -Options: - -V, --version Output the current version of the CLI Toolkit. - -h, --help display help for command - --color force color output - --no-color disable color output - -Commands: - get-turso Get the latest version of Turso. - help Show help for command - init Initialization Tools. -``` - #### `get-turso` Lädt die neueste Version von Turso herunter und installiert sie mit dem Skript aus -Turso's [Dokumentation](https://docs.turso.tech/cli/installation) +Turso's [Dokumentation][turso-docs]. :::note Windows erfordert die Verwendung von WSL wie bei Turso @@ -169,49 +282,56 @@ Options: -h, --help display help for command ``` -#### `init` - -```log -Usage: studiocms init [options] - -Initialize the StudioCMS project after new installation. - -Options: - -d, --dry-run Dry run mode - --skip-banners Skip all banners - --debug Enable debug mode - -h, --help Display help for command -``` - -Der init-Befehl bietet eine interaktive Einrichtungsmöglichkeit, die dir hilft: +## `@studiocms-upgrade` -1. Richte deine Umgebungsdatei (.env) mit den folgenden Optionen ein: - - eine Beispiel-`.env`-Vorlage zu verwenden - - den interaktiven `.env`-Builder zu verwenden, mit dem du: - - Eine neue Turso-Datenbank einrichten (wenn nicht unter Windows) - - OAuth-Anbieter konfigurieren (GitHub, Discord, Google, Auth0) - - Verschlüsselungsschlüssel und andere erforderliche Variablen setzen - - Die Erstellung von Umgebungsdateien überspringen - -2. Der Befehl beinhaltet die automatische Turso CLI-Installation und die Authentifizierung, falls dies beim Einrichten einer Datenbank erforderlich ist. +Ein Kommandozeilen-Tool zum Aktualisieren deiner StudioCMS-Installation und Abhängigkeiten -## Umgebungsvariablen +Du kannst diesen Befehl in deinem Terminal ausführen, um dein offizielles Astro Project, die Integrationen gleichzeitig mit StudioCMS zu aktualisieren. -Für StudioCMS müssen mehrere Umgebungsvariablen konfiguriert werden. Hier sind die wichtigsten Variablen: +### Beispiel für die Verwendung -```dotenv -# Datenbank-Konfiguration -ASTRO_DB_REMOTE_URL=libsql://your-database.turso.io -ASTRO_DB_APP_TOKEN=your-token + + + ```sh + npx @studiocms/upgrade + ``` + + + ```sh + pnpm dlx @studiocms/upgrade + ``` + + + ```sh + yarn dlx @studiocms/upgrade + ``` + + -# Auth-Konfiguration -CMS_ENCRYPTION_KEY="..." # Generated with openssl rand --base64 16 -``` +### Optionen -Eine vollständige Liste der Umgebungsvariablen findest du in der [Dokumentation Umgebungsvariablen][environment-variables]. +#### `tag` (optional) -Du kannst diese Variablen mit dem interaktiven Environment Builder des Befehls `studiocms init` einrichten. +Es ist möglich, ein bestimmtes `tag` zu übergeben, nach dem Pakete aufgelöst werden. Wenn dies nicht der Fall ist, sucht `@studiocms/upgrade` nach dem `latest` Tag. + + + ```sh + npx @studiocms/upgrade beta + ``` + + + ```sh + pnpm dlx @studiocms/upgrade beta + ``` + + + ```sh + yarn dlx @studiocms/upgrade beta + ``` + + +[turso-docs]: https://docs.turso.tech/cli/installation [templates]: https://github.com/withstudiocms/templates [environment-variables]: /de/start-here/environment-variables/ \ No newline at end of file From af8aafc6720e763d40c0022aa930af135ee8ec52 Mon Sep 17 00:00:00 2001 From: trueberryless Date: Sun, 20 Apr 2025 21:05:06 +0200 Subject: [PATCH 07/11] docs: translate rest of the missing file changes --- .../contributing/code-contributions.mdx | 2 +- src/content/docs/de/index.mdx | 4 +- src/content/docs/de/package-catalog/index.mdx | 2 + .../studiocms-plugins/studiocms-blog.mdx | 6 +-- .../studiocms-plugins/studiocms-markdoc.mdx | 6 +-- .../studiocms-plugins/studiocms-mdx.mdx | 6 +-- .../studiocms-plugins/studiocms-wysiwyg.mdx | 37 +++++++++++++++++++ .../docs/de/start-here/getting-started.mdx | 13 ++++--- 8 files changed, 59 insertions(+), 17 deletions(-) create mode 100644 src/content/docs/de/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx diff --git a/src/content/docs/de/guides/contributing/code-contributions.mdx b/src/content/docs/de/guides/contributing/code-contributions.mdx index 8196448e..d7b53f53 100644 --- a/src/content/docs/de/guides/contributing/code-contributions.mdx +++ b/src/content/docs/de/guides/contributing/code-contributions.mdx @@ -60,4 +60,4 @@ Jetzt, wo du Teil der StudioCMS-Community bist, kannst du uns helfen, andere PRs Oh, und du wirst dein Gesicht in der [Liste der Mitwirkenden][contributors] sehen! 🎉 {/* Links */} -[contributors]: /de/guides/contributing/getting-started/#unsere-mitwirkenden \ No newline at end of file +[contributors]: /de/guides/contributing/getting-started/#unsere-mitwirkenden diff --git a/src/content/docs/de/index.mdx b/src/content/docs/de/index.mdx index bc16dbba..c727bbfa 100644 --- a/src/content/docs/de/index.mdx +++ b/src/content/docs/de/index.mdx @@ -28,8 +28,8 @@ import ListCard from "~/components/landing/ListCard.astro"; import SplitCard from "~/components/landing/SplitCard.astro"; import { Center } from "studiocms:ui/components"; - - + + diff --git a/src/content/docs/de/package-catalog/index.mdx b/src/content/docs/de/package-catalog/index.mdx index 64f626a3..0caa7936 100644 --- a/src/content/docs/de/package-catalog/index.mdx +++ b/src/content/docs/de/package-catalog/index.mdx @@ -11,6 +11,8 @@ Der Paketkatalog ist eine Sammlung von Paketen von StudioCMS oder seinen Communi Jedes Paket, das als gekennzeichnet ist, ist ein Paket, das die Funktionalität von StudioCMS oder seinem Dashboard erweitert. +Plugins können auch als gekennzeichnet sein, was bedeutet, dass sich das Plugin noch in einem frühen Entwicklungsstadium befindet und jederzeit größere Änderungen an seinen Interna vorgenommen werden können. Dieses Plugin ist möglicherweise noch nicht einsatzbereit. + Jedes Paket, das als gekennzeichnet ist, kann installiert und in Projekten verwendet werden, die nicht auf StudioCMS angewiesen sind. Sie können eigenständig arbeiten. ## Paket-Kataloge diff --git a/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-blog.mdx b/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-blog.mdx index 4b1cdba1..02d8ff82 100644 --- a/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-blog.mdx +++ b/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-blog.mdx @@ -21,11 +21,11 @@ Dieses Plugin aktiviert die StudioCMS Blog-Funktionen sowie ein Frontend in dein 1. Installiere das Paket mit dem folgenden Befehl: - + -2. Füge `@studiocms/blog` zu deiner Astro-Konfigurationsdatei hinzu: +2. Deine StudioCMS-Konfiguration sollte jetzt `@studiocms/blog` enthalten: - ```ts twoslash title="studiocms.config.mjs" ins={2, 6} + ```ts twoslash title="studiocms.config.mjs" {2, 6} import { defineStudioCMSConfig } from 'studiocms/config'; import blog from '@studiocms/blog'; diff --git a/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-markdoc.mdx b/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-markdoc.mdx index 1f64423a..d1252da6 100644 --- a/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-markdoc.mdx +++ b/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-markdoc.mdx @@ -21,11 +21,11 @@ Dieses Plugin ermöglicht die MarkDoc-Unterstützung in StudioCMS. 1. Installiere das Paket mit dem folgenden Befehl: - + -2. Füge `@studiocms/markdoc` zu deiner Astro-Konfigurationsdatei hinzu: +2. Deine StudioCMS-Konfiguration sollte jetzt `@studiocms/markdoc` enthalten: - ```ts twoslash title="studiocms.config.mjs" ins={2, 6} + ```ts twoslash title="studiocms.config.mjs" {2, 6} import { defineStudioCMSConfig } from 'studiocms/config'; import markdoc from '@studiocms/markdoc'; diff --git a/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-mdx.mdx b/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-mdx.mdx index 529c1f24..d86ac3e1 100644 --- a/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-mdx.mdx +++ b/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-mdx.mdx @@ -21,11 +21,11 @@ Dieses Plugin ermöglicht die MDX-Unterstützung in StudioCMS. 1. Installiere das Paket mit dem folgenden Befehl: - + -2. Füge `@studiocms/mdx` zu deiner Astro-Konfigurationsdatei hinzu: +2. Deine StudioCMS-Konfiguration sollte jetzt `@studiocms/mdx` enthalten: - ```ts twoslash title="studiocms.config.mjs" ins={2, 6} + ```ts twoslash title="studiocms.config.mjs" {2, 6} import { defineStudioCMSConfig } from 'studiocms/config'; import mdx from '@studiocms/mdx'; diff --git a/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx b/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx new file mode 100644 index 00000000..b57d7403 --- /dev/null +++ b/src/content/docs/de/package-catalog/studiocms-plugins/studiocms-wysiwyg.mdx @@ -0,0 +1,37 @@ +--- +i18nReady: true +title: "@studiocms/wysiwyg" +type: integration +catalogEntry: studiocms-wysiwyg +description: "Füge einen WYSIWYG-Editor zu deinem StudioCMS-Projekt hinzu - ganz einfach!" +sidebar: + badge: + text: 'Experimentell' + variant: 'danger' +--- + +import { PackageManagers } from 'starlight-package-managers' +import { Steps, Tabs, TabItem } from '@astrojs/starlight/components'; + +# Einführung + +Dieses Plugin fügt deinem StudioCMS-Projekt ganz einfach einen WYSIWYG-Editor hinzu! + +## Installation + +1. Installiere das Paket mit dem folgenden Befehl: + + + +2. Deine StudioCMS-Konfiguration sollte jetzt `@studiocms/wysiwyg` enthalten: + + ```ts twoslash title="studiocms.config.mjs" {2, 6} + import { defineStudioCMSConfig } from 'studiocms/config'; + import wysiwyg from '@studiocms/wysiwyg'; + + export default defineStudioCMSConfig({ + plugins: [ + wysiwyg(), + ], + }); + ``` \ No newline at end of file diff --git a/src/content/docs/de/start-here/getting-started.mdx b/src/content/docs/de/start-here/getting-started.mdx index 4df3bf37..c48cdc75 100644 --- a/src/content/docs/de/start-here/getting-started.mdx +++ b/src/content/docs/de/start-here/getting-started.mdx @@ -8,22 +8,24 @@ sidebar: import { PackageManagers } from 'starlight-package-managers' import TursoCLI from '~/components/TursoCLI.astro'; -import { Aside, Steps, Tabs, TabItem } from '@astrojs/starlight/components'; +import { Aside, Steps, Tabs, TabItem, LinkCard } from '@astrojs/starlight/components'; import ReadMore from '~/components/ReadMore.astro'; import { sponsors, SponsorLink } from '~/share-link' + + ## Los geht's Um StudioCMS zu benutzen, brauchst du: - Eine von [Astro unterstützte Version von Node.js](https://docs.astro.build/de/install-and-setup/#prerequisites) (Bun und Deno werden nicht unterstützt) - Ein Astro-Projekt -- Ein libSQL-Anbieter oder ein selbst gehosteter libSQL-Server +- Ein libSQL-Anbieter oder ein [selbst gehosteter libSQL-Server][self-hosted-libsql] - Die StudioCMS-Integration ## Bereite deine Datenbank vor -StudioCMS verwendet `@astrojs/db`, um sich mit deiner libSQL-Datenbank zu verbinden. Du kannst jeden libSQL-Anbieter oder einen selbst gehosteten libSQL-Server verwenden. +StudioCMS verwendet `@astrojs/db`, um sich mit deiner libSQL-Datenbank zu verbinden. Du kannst jeden libSQL-Anbieter oder einen [selbst gehosteten libSQL-Server][self-hosted-libsql] verwenden. Wenn du die StudioCMS CLI verwendest, kannst du diesen Schritt überspringen und die CLI verwenden, um eine neue Datenbank zu erstellen, wenn du die Turso CLI installiert hast. @@ -208,7 +210,7 @@ libSQL unterstützt sowohl HTTP als auch WebSockets als Transportprotokoll für -Bitte beachte, dass die Option `site` in der Datei `astro.config.mjs` erforderlich ist, damit StudioCMS korrekt funktioniert. Du kannst hier die URL deiner Website oder eine Platzhalter-URL angeben. (z.B. `https://demo.studiocms.xyz/` oder `http://localhost:4321/`) +Bitte beachte, dass die Option `site` in der Datei `astro.config.mjs` erforderlich ist, damit StudioCMS korrekt funktioniert. Du kannst hier die URL deiner Website oder eine Platzhalter-URL angeben. (z.B. `https://demo.studiocms.dev/` oder `http://localhost:4321/`)