-
-
Notifications
You must be signed in to change notification settings - Fork 411
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #344 from yamadashy/feat/website-cli-docs
docs(website): Add local development instructions for website to CONTRIBUTING.md
- Loading branch information
Showing
36 changed files
with
1,879 additions
and
512 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,33 @@ | ||
| # Repomix Website | ||
|
|
||
| This directory contains the source code for the Repomix website, built with [VitePress](https://vitepress.dev/) and [Vue.js](https://vuejs.org/) | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Docker must be installed on your system | ||
|
|
||
| ## Development | ||
|
|
||
| To start the development server: | ||
|
|
||
| ```bash | ||
| # Start the website development server | ||
| npm run website | ||
|
|
||
| # Access the website at http://localhost:5173/ | ||
| ``` | ||
|
|
||
| ## Documentation | ||
|
|
||
| When updating documentation, you only need to update the English version (`client/src/en/`). | ||
| The maintainers will handle translations to other languages. | ||
|
|
||
| ## Building for Production | ||
|
|
||
| To build the website for production: | ||
|
|
||
| ```bash | ||
| npm run website:build | ||
| ``` | ||
|
|
||
| The built files will be available in the `client/dist` directory. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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', | ||
| }, | ||
| }, | ||
| }, | ||
| }, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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 | ||
| ``` |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| 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. |
Oops, something went wrong.