shokunin -Download - shokunin -Quellcode herunterladen

shokunin

Andere Kategorien

v0.0.32

Herunterladen

Shokunin Static Site Generator (SSG)

Ein in Rust erstellter Content-First-Static-Site-Generator, optimiert für Leistung, Zugänglichkeit und Sichtbarkeit in Suchmaschinen.

• Website • Dokumentation • Fehler melden • Anforderungsfunktion • Richtlinien für Beiträge

Überblick

Shokunin ist ein in Rust entwickelter leistungsstarker statischer Site-Generator (SSG), der Folgendes priorisiert:

Content-First-Entwicklungsansatz
Blitzschnelle Site-Generierung
WCAG 2.1 Level AA-Zugänglichkeitskonformität
Erweiterte SEO-Optimierung
Typsichere Operationen mit umfassender Fehlerbehandlung

Hauptmerkmale

Kernkompetenzen

⚡ Außergewöhnliche Leistung : Kostenfreie Abstraktionen durch Rust
SEO-Optimierung : Integrierte Verbesserungen für die Sichtbarkeit in der Suche
♿ Zugänglichkeit : Automatische WCAG 2.1 Level AA-Konformität
Multiformat-Unterstützung : Verarbeitet Markdown, YAML, JSON und TOML
Feed-Generierung : Automatische Atom- und RSS-Feed-Erstellung
Analytics : Native Google- und Bing Analytics-Integration
? Themen : Benutzerdefinierte HTML-Themen und Vorlagenunterstützung

Entwicklungsfunktionen

? CLI-Tools : Umfassende Befehlszeilenschnittstelle
Dev Server : Integrierter Rust-Server für lokale Entwicklung
? Hot Reload : Automatische Inhaltsaktualisierungen während der Entwicklung
Typsicherheit : Garantierte Speicher- und Thread-Sicherheit
⚡ Async-Unterstützung : Vollständige asynchrone Betriebsfunktionen

Erste Schritte ?

Installation

Fügen Sie zu Ihrem Cargo.toml hinzu:

[ dependencies ]
ssg = " 0.0.32 "

Oder über Cargo installieren:

cargo install ssg

Grundlegende Verwendung

 use staticdatagen :: compiler :: service :: compile ;
use std :: { path :: Path , error :: Error } ;

fn main ( ) -> Result < ( ) , Box < dyn Error > > {
    // Define directory paths
    let build_dir = Path :: new ( "./examples/build" ) ;          // Build directory
    let content_dir = Path :: new ( "./examples/content" ) ;      // Content directory
    let public_dir = Path :: new ( "./examples/public" ) ;        // Public directory
    let template_dir = Path :: new ( "./examples/templates" ) ;   // Templates

    // Generate site
    compile ( build_dir , content_dir , public_dir , template_dir ) ? ;
    println ! ( " Site generated successfully!" ) ;
    Ok ( ( ) )
}

CLI-Nutzung

Erstellen Sie eine neue Website:

 # Full command syntax
ssg --content=content --template=templates --serve=public

# Short form
ssg -c=content -t=templates -o=output -s=public

# Using cargo run
cargo run --bin ssg -- -c= " ./examples/content " -t= " ./examples/templates " -s= " ./examples/public "

CLI-Optionen

Option	Kurz	Beschreibung	Erforderlich
`--content`	`-c`	Inhaltspfad	Ja
`--template`	`-t`	Vorlagenpfad	Ja
`--serve`	`-s`	Öffentlicher Serverpfad	Ja

Beispiele

Probieren Sie unsere Beispielimplementierungen aus:

 # Basic example
# # Convert Markdown to static sites effortlessly, with templates, organized builds, and instant local hosting.
git clone https://github.com/sebastienrousseau/shokunin.git
cd shokunin
cargo run --example basic

# Quick start example
# # Create, compile, and host a static site effortlessly with Shokunin: simple setup, error handling, and instant local server for previews.
cargo run --example quickstart

# Multilingual example
# # Build multilingual static sites effortlessly: generate language-specific sites, create a language selector, and serve all from a single directory.
cargo run --example multilingual