Imgbot

Imgbot

Imgbot kriecht alle Ihre Bilddateien in GitHub und gibt Nachanwaltungen nach einem Verlust weniger Komprimierung ein. Dies führt dazu, dass die Dateigröße sinkt, aber die Abmessungen und Qualität genauso gut.

Konfiguration

IMGBOT unterstützt die optionale Konfiguration über eine .imgbotconfig -JSON -Datei. Dies ist kein erforderlicher Schritt zur Verwendung von ImgBot und ist nur für fortgeschrittenere Szenarien gilt. Diese Datei sollte in das Stamm zum Repository platziert und auf Ihren Geschmack eingestellt werden.

 {
    "schedule": "daily", // daily|weekly|monthly
    "ignoredFiles": [
    	"*.jpg",                   // by extension
    	"image1.png",              // by filename
    	"public/special_images/*", // by folderpath
    ],
    "aggressiveCompression": "true", // true|false
    "compressWiki": "true", // true|false
    "minKBReduced": 500 // set reduction threshold (default to 10),
    "prTitle" : "Compressed images", // set pull request title
    // set the pull request body, supports any valid github markdown
    // {optimization_ratio} display a message containing the optimization ratio
    // {optimization_details} display the table containing the optimization details
    "prBody" : " Text before optimization ratio {optimization_ratio} Text after optimization ratio 
                Text before optimization details {optimization_details} Text after optimization details",
    
}

Im Folgenden sind die derzeit unterstützten Parameter aufgeführt. Wenn es Konfigurationseinstellungen gibt, die Sie verändert oder unterstützt sehen möchten, können Sie hier im Repo ein Problem öffnen oder eine E -Mail an [email protected] abgeben.

Zeitplan

• Optional
• Akzeptiert: Tageszeitung | monatlich
• Begrenzt die PRs von Imgbot auf einmal am Tag, einmal pro Woche oder einmal im Monat
• Das Standardverhalten besteht darin, IMGBOT -PRs zu empfangen, da Bilder eine Optimierung erfordern

ignorierte Dateien

• Optional
• Akzeptiert die Syntax für die Suche im Verzeichnis. EnumerateFiles ()
• Begrenzt die von Imgbot optimierten Bilder, indem sie im Wesentlichen ignoriert werden
• Wenn das Ignorieren durch Dateinamenname kein Pfad erforderlich ist, ist beim Ignorieren durch den Ordnernamen der vollständige Pfad vom Root erforderlich

Aggressive Ankompression

• Optional
• Akzeptiert: wahr | false
• Entscheiden Sie sich für die Verwendung verlustiger Komprimierungsalgorithmen
• Das Standardverhalten ohne diese Einstellung ist der Verlust weniger Komprimierung

Compresswiki

• Optional
• Akzeptiert: wahr | false
• Entscheiden Sie sich, auch Wiki Repo zu komprimieren
  • Beispiel: https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git
• Das Standardverhalten ist out out

Nerkbannung

• Optional
• Akzeptiert nur Zahlen als Eingabe (z. B. "minKBReduced": 500 für einen 500 -KB -Schwellenwert).
• Kann verwendet werden, um die Häufigkeit von PRS -IMGBOT im Laufe der Zeit zu begrenzen
• Die Standardeinstellung ist 10

Prtitle

• Optional
• Nur für bezahlte Pläne verfügbar
• Akzeptiert nur Zeichenfolgen als Eingabe (z. B. "prTitle": "My title" )
• Kann verwendet werden, um einen beliebigen benutzerdefinierten Pull -Anfrage -Titel anzuzeigen
• Die Standardeinstellung lautet "[imgbot] optimieren Sie Bilder".

prkody

• Optional
• Nur für bezahlte Pläne verfügbar
• Akzeptiert nur Zeichenfolgen als Eingabe
• (zB "prBody": "Text before {optimization_ratio} Text after"
Text before {optimization_details} Text after" )
• Kann verwendet werden, um eine benutzerdefinierte Pull -Anforderungsbehörde anzuzeigen, die mit dem GitHub -Markdown geschrieben wurde
• Unterstützt zwei magische Tags: {optimization_ratio} //displays the mean optimization ratio for all images
{optimization_details} //display the optimization details for every images
• Die Standardeinstellung generiert den hier angezeigten Körper

Erfahren Sie mehr: https://imgbot.net/docs

Beitragen

Der gesamte Code für IMGBOT ist auf GitHub verfügbar. Wir akzeptieren gerne Beiträge für den Service, die Website und die Dokumentation. Hier können Sie herausfinden, wie Sie einrichten können, um lokal auszuführen, sowie detaillierte Informationen darüber, wie IMGBOT funktioniert.

https://imgbot.net/docs#contributing