Skip to content

Commit

Permalink
docs(website): Add German and fix clarifications in translations
Browse files Browse the repository at this point in the history
  • Loading branch information
yamadashy committed Feb 8, 2025
1 parent 6ecfbc8 commit 4b0f5f5
Show file tree
Hide file tree
Showing 26 changed files with 1,541 additions and 204 deletions.
2 changes: 2 additions & 0 deletions website/client/.vitepress/config.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
import { defineConfig } from 'vitepress';
import { configDe } from './config/configDe';
import { configEnUs } from './config/configEnUs';
import { configEs } from './config/configEs';
import { configJa } from './config/configJa';
Expand All @@ -16,5 +17,6 @@ export default defineConfig({
es: { label: 'Español', ...configEs },
'pt-br': { label: 'Português', ...configPtBr },
ko: { label: '한국어', ...configKo },
de: { label: 'Deutsch', ...configDe },
},
});
66 changes: 66 additions & 0 deletions website/client/.vitepress/config/configDe.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,66 @@
import { type DefaultTheme, defineConfig } from 'vitepress';

export const configDe = defineConfig({
lang: 'de',
description: 'Verpacken Sie Ihren Code in AI-freundliche Formate',
themeConfig: {
nav: [
// guide
{ text: 'Anleitung', link: '/de/guide/' },
{ text: 'Discord beitreten', link: 'https://discord.gg/wNYzTwZFku' },
],
sidebar: {
'/de/guide/': [
{
text: 'Anleitung',
items: [
{ text: 'Erste Schritte', link: '/de/guide/' },
{ text: 'Installation', link: '/de/guide/installation' },
{ text: 'Verwendung', link: '/de/guide/usage' },
{ text: 'Prompt-Beispiele', link: '/de/guide/prompt-examples' },
{ text: 'Ausgabeformate', link: '/de/guide/output' },
{ text: 'Befehlszeilenoptionen', link: '/de/guide/command-line-options' },
{ text: 'Remote-Repository-Verarbeitung', link: '/de/guide/remote-repository-processing' },
{ text: 'Konfiguration', link: '/de/guide/configuration' },
{ text: 'Benutzerdefinierte Anweisungen', link: '/de/guide/custom-instructions' },
{ text: 'Kommentarentfernung', link: '/de/guide/comment-removal' },
{ text: 'Sicherheit', link: '/de/guide/security' },
{
text: 'Tipps & Tricks',
items: [{ text: 'Best Practices', link: '/de/guide/tips/best-practices' }],
},
{
text: 'Entwicklung',
items: [
{ text: 'Beitragen', link: '/de/guide/development/' },
{ text: 'Einrichtung', link: '/de/guide/development/setup' },
],
},
],
},
],
},
},
});

export const configDeSearch: DefaultTheme.LocalSearchOptions['locales'] = {
de: {
translations: {
button: {
buttonText: 'Suchen',
buttonAriaLabel: 'Suchen',
},
modal: {
displayDetails: 'Detaillierte Liste anzeigen',
resetButtonTitle: 'Suche zurücksetzen',
backButtonTitle: 'Schließen',
noResultsText: 'Keine Ergebnisse für',
footer: {
selectText: 'zum Auswählen',
navigateText: 'zur Navigation',
closeText: 'zum Schließen',
},
},
},
},
};
1 change: 1 addition & 0 deletions website/client/.vitepress/config/configJa.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@ export const configJa = defineConfig({
description: 'コードベースをAIフレンドリーな形式にパッケージング',
themeConfig: {
nav: [
// guide
{ text: '使い方', link: '/ja/guide/' },
{ text: 'Discordに参加', link: 'https://discord.gg/wNYzTwZFku' },
],
Expand Down
6 changes: 4 additions & 2 deletions website/client/.vitepress/config/configShard.ts
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
import { visualizer } from 'rollup-plugin-visualizer';
import { type ManifestOptions, VitePWA } from 'vite-plugin-pwa';
import { defineConfig } from 'vitepress';
import { configDeSearch } from './configDe';
import { configEsSearch } from './configEs';
import { configJaSearch } from './configJa';
import { configKoSearch } from './configKo';
Expand Down Expand Up @@ -62,11 +63,12 @@ export const configShard = defineConfig({
provider: 'local',
options: {
locales: {
...configDeSearch,
...configEsSearch,
...configJaSearch,
...configZhCnSearch,
...configKoSearch,
...configPtBrSearch,
...configEsSearch,
...configZhCnSearch,
},
},
},
Expand Down
65 changes: 65 additions & 0 deletions website/client/src/de/guide/command-line-options.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,65 @@
# Befehlszeilenoptionen

## Grundlegende Optionen
- `-v, --version`: Zeigt die Version des Tools an

## Ausgabeoptionen
- `-o, --output <file>`: Name der Ausgabedatei (Standard: `repomix-output.txt`)
- `--style <type>`: Ausgabestil (`plain`, `xml`, `markdown`) (Standard: `plain`)
- `--parsable-style`: Aktiviert analysierbare Ausgabe basierend auf dem gewählten Stilschema (Standard: `false`)
- `--output-show-line-numbers`: Zeilennummern hinzufügen (Standard: `false`)
- `--copy`: In die Zwischenablage kopieren (Standard: `false`)
- `--no-file-summary`: Dateizusammenfassung deaktivieren (Standard: `true`)
- `--no-directory-structure`: Verzeichnisstruktur deaktivieren (Standard: `true`)
- `--remove-comments`: Kommentare entfernen (Standard: `false`)
- `--remove-empty-lines`: Leere Zeilen entfernen (Standard: `false`)
- `--header-text <text>`: Benutzerdefinierten Text im Dateikopf einfügen
- `--instruction-file-path <path>`: Pfad zu einer Datei mit detaillierten benutzerdefinierten Anweisungen
- `--include-empty-directories`: Leere Verzeichnisse in die Ausgabe einschließen (Standard: `false`)

## Filteroptionen
- `--include <patterns>`: Einschlussmuster (durch Kommas getrennt)
- `-i, --ignore <patterns>`: Ignorierungsmuster (durch Kommas getrennt)
- `--no-gitignore`: .gitignore-Dateiverwendung deaktivieren
- `--no-default-patterns`: Standardmuster deaktivieren

## Remote-Repository-Optionen
- `--remote <url>`: Remote-Repository verarbeiten
- `--remote-branch <n>`: Remote-Branch-Namen, Tag oder Commit-Hash angeben (Standard: Repository-Standardbranch)

## Konfigurationsoptionen
- `-c, --config <path>`: Pfad zur benutzerdefinierten Konfigurationsdatei
- `--init`: Konfigurationsdatei erstellen
- `--global`: Globale Konfiguration verwenden

## Sicherheitsoptionen
- `--no-security-check`: Sicherheitsprüfung deaktivieren (Standard: `true`)

## Token-Zählungsoptionen
- `--token-count-encoding <encoding>`: Token-Zählungskodierung angeben (z.B. `o200k_base`, `cl100k_base`) (Standard: `o200k_base`)

## Weitere Optionen
- `--top-files-len <number>`: Anzahl der anzuzeigenden Top-Dateien (Standard: `5`)
- `--verbose`: Ausführliche Protokollierung aktivieren

## Beispiele

```bash
# Grundlegende Verwendung
repomix

# Benutzerdefinierte Ausgabe
repomix -o output.xml --style xml

# Bestimmte Dateien verarbeiten
repomix --include "src/**/*.ts" --ignore "**/*.test.ts"

# Remote-Repository mit Branch
repomix --remote https://github.com/user/repo/tree/main

# Remote-Repository mit Commit
repomix --remote https://github.com/user/repo/commit/836abcd7335137228ad77feb28655d85712680f1

# Remote-Repository mit Kurzform
repomix --remote user/repo
```
53 changes: 53 additions & 0 deletions website/client/src/de/guide/comment-removal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,53 @@
# Kommentarentfernung

Repomix kann beim Generieren der Ausgabedatei automatisch Kommentare aus Ihrer Codebasis entfernen. Dies kann helfen, Störungen zu reduzieren und sich auf den eigentlichen Code zu konzentrieren.

## Verwendung

Um die Kommentarentfernung zu aktivieren, setzen Sie die Option `removeComments` in Ihrer `repomix.config.json` auf `true`:

```json
{
"output": {
"removeComments": true
}
}
```

## Unterstützte Sprachen

Repomix unterstützt die Kommentarentfernung für eine Vielzahl von Programmiersprachen, einschließlich:

- JavaScript/TypeScript (`//`, `/* */`)
- Python (`#`, `"""`, `'''`)
- Java (`//`, `/* */`)
- C/C++ (`//`, `/* */`)
- HTML (`<!-- -->`)
- CSS (`/* */`)
- Und viele mehr...

## Beispiel

Gegeben sei der folgende JavaScript-Code:

```javascript
// Dies ist ein einzeiliger Kommentar
function test() {
/* Dies ist ein
mehrzeiliger Kommentar */
return true;
}
```

Mit aktivierter Kommentarentfernung wird die Ausgabe wie folgt aussehen:

```javascript
function test() {
return true;
}
```

## Hinweise

- Die Kommentarentfernung wird vor anderen Verarbeitungsschritten durchgeführt, wie z.B. der Zeilennummerierung.
- Einige Kommentare, wie JSDoc-Kommentare, können je nach Sprache und Kontext erhalten bleiben.
84 changes: 84 additions & 0 deletions website/client/src/de/guide/configuration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,84 @@
# Konfiguration

## Schnellstart

Konfigurationsdatei erstellen:
```bash
repomix --init
```

## Konfigurationsdatei

`repomix.config.json`:
```json
{
"output": {
"filePath": "repomix-output.xml",
"style": "xml",
"headerText": "Benutzerdefinierter Kopfzeilentext",
"instructionFilePath": "repomix-instruction.md",
"fileSummary": true,
"directoryStructure": true,
"removeComments": false,
"removeEmptyLines": false,
"topFilesLength": 5,
"showLineNumbers": false,
"copyToClipboard": false,
"includeEmptyDirectories": false
},
"include": ["**/*"],
"ignore": {
"useGitignore": true,
"useDefaultPatterns": true,
"customPatterns": ["tmp/", "*.log"]
},
"security": {
"enableSecurityCheck": true
}
}
```

## Globale Konfiguration

Globale Konfiguration erstellen:
```bash
repomix --init --global
```

Speicherort:
- Windows: `%LOCALAPPDATA%\Repomix\repomix.config.json`
- macOS/Linux: `~/.config/repomix/repomix.config.json`

## Ignorier-Muster

Prioritätsreihenfolge:
1. CLI-Optionen (`--ignore`)
2. .repomixignore
3. .gitignore
4. Standardmuster

`.repomixignore` Beispiel:
```text
# Cache-Verzeichnisse
.cache/
tmp/
# Build-Ausgaben
dist/
build/
# Protokolle
*.log
```

## Standard-Ignorier-Muster

Standardmäßig enthaltene häufige Muster:
```text
node_modules/**
.git/**
coverage/**
dist/**
```

Vollständige Liste: [defaultIgnore.ts](https://github.com/yamadashy/repomix/blob/main/src/config/defaultIgnore.ts)
43 changes: 43 additions & 0 deletions website/client/src/de/guide/custom-instructions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
# Benutzerdefinierte Anweisungen

Repomix ermöglicht es Ihnen, benutzerdefinierte Anweisungen bereitzustellen, die in die Ausgabedatei aufgenommen werden. Dies kann nützlich sein, um Kontext oder spezifische Richtlinien für KI-Systeme hinzuzufügen, die das Repository verarbeiten.

## Verwendung

Um eine benutzerdefinierte Anweisung einzufügen, erstellen Sie eine Markdown-Datei (z.B. `repomix-instruction.md`) im Stammverzeichnis Ihres Repositories. Geben Sie dann den Pfad zu dieser Datei in Ihrer `repomix.config.json` an:

```json
{
"output": {
"instructionFilePath": "repomix-instruction.md"
}
}
```

Der Inhalt dieser Datei wird in der Ausgabe unter dem Abschnitt "Instruction" aufgenommen.

## Beispiel

```markdown
# Repository-Anweisungen

Dieses Repository enthält den Quellcode für das Repomix-Tool. Bitte beachten Sie diese Richtlinien bei der Analyse des Codes:

1. Konzentrieren Sie sich auf die Kernfunktionalität im Verzeichnis `src/core`.
2. Achten Sie besonders auf die Sicherheitsprüfungen in `src/core/security`.
3. Ignorieren Sie alle Dateien im Verzeichnis `tests`.
```

Dies führt zu folgendem Abschnitt in der Ausgabe:

```xml
<instruction>
# Repository-Anweisungen

Dieses Repository enthält den Quellcode für das Repomix-Tool. Bitte beachten Sie diese Richtlinien bei der Analyse des Codes:

1. Konzentrieren Sie sich auf die Kernfunktionalität im Verzeichnis `src/core`.
2. Achten Sie besonders auf die Sicherheitsprüfungen in `src/core/security`.
3. Ignorieren Sie alle Dateien im Verzeichnis `tests`.
</instruction>
```
Loading

0 comments on commit 4b0f5f5

Please sign in to comment.