Crate ssg

Expand description

Shokunin logo

§Shokunin Static Site Generator (SSG)

A content-first static site generator crafted in Rust, optimized for performance, accessibility, and search engine visibility.

• Website • Documentation • Report Bug • Request Feature • Contributing Guidelines

§Overview 🚀

Shokunin is a high-performance static site generator (SSG) engineered in Rust that prioritises:

Content-first development approach
Lightning-fast site generation
WCAG 2.1 Level AA accessibility compliance
Advanced SEO optimization
Type-safe operations with comprehensive error handling

§Key Features 🎯

§Core Capabilities

⚡ Exceptional Performance: Zero-cost abstractions through Rust
📱 SEO Optimization: Built-in enhancements for search visibility
♿ Accessibility: Automatic WCAG 2.1 Level AA compliance
🛠️ Multi-format Support: Handles Markdown, YAML, JSON, and TOML
🔄 Feed Generation: Automatic Atom and RSS feed creation
📊 Analytics: Native Google and Bing Analytics integration
🎨 Theming: Custom HTML themes and template support

§Development Features

🔧 CLI Tools: Comprehensive command-line interface
🚀 Dev Server: Built-in Rust server for local development
🔍 Hot Reload: Automatic content updates during development
📝 Type Safety: Guaranteed memory and thread safety
⚡ Async Support: Full asynchronous operation capabilities

§Getting Started 📦

§Installation

Add to your Cargo.toml:

[dependencies]
ssg = "0.0.32"

Or install via Cargo:

cargo install ssg

§Basic Usage

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 Usage

Create a new site:

# 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 Options

Option	Short	Description	Required
`--content`	`-c`	Content path	Yes
`--template`	`-t`	Template path	Yes
`--serve`	`-s`	Server Public path	Yes

§Examples 📚

Try our example implementations:

# 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

§Documentation 📖

§Contributing 🤝

We welcome contributions! Please see our Contributing Guidelines for details on:

Code of Conduct
Development Process
Pull Request Guidelines
Issue Reporting

§License 📄

This project is dual-licensed under:

at your option.

§Acknowledgements 🙏

Special thanks to all contributors who have helped build Shokunin.

Re-exports§

pub use staticdatagen;

Modules§

cmd: Command Line Interface Module
process: Module declarations

Structs§

Paths: Represents the necessary directory paths for the site generator.
PathsBuilder: Builder for creating Paths configurations

Functions§

collect_files_recursive: Recursively collects all file paths within a directory.
copy_dir_all: Recursively copies a directory whilst maintaining structure and attributes.
copy_dir_all_async: Asynchronously copies an entire directory structure, preserving file attributes and handling nested directories.
copy_dir_with_progress: Recursively copies directories with a progress bar for feedback.
create_directories: Creates and verifies required directories for site generation.
create_log_file: Creates and initialises a log file for the static site generator.
handle_server: Configures and launches the development server.
is_safe_path: Checks if a given path is safe to use.
log_arguments: Logs processed command-line arguments for debugging and auditing.
log_initialization: Records system initialisation in the logging system.
run: Executes the static site generation process.
verify_and_copy_files: Validates and copies files from source to destination.
verify_and_copy_files_async: Asynchronously validates and copies files between directories.
verify_file_safety: Verifies the safety of a file for processing.

Crate ssgCopy item path