shokunin

职人静态站点生成器 (SSG)

用 Rust 制作的内容优先的静态站点生成器，针对性能、可访问性和搜索引擎可见性进行了优化。

• 网站 • 文档 • 报告错误 • 请求功能 • 贡献指南

概述

Shokunin 是一款用 Rust 设计的高性能静态站点生成器 (SSG)，它优先考虑：

• 内容优先的开发方法
• 闪电般快速的网站生成
• WCAG 2.1 AA 级无障碍合规性
• 高级 SEO 优化
• 具有全面错误处理功能的类型安全操作

主要特点

核心能力

• ⚡ 卓越的性能：通过 Rust 进行零成本抽象
• SEO 优化：搜索可见性的内置增强功能
• ♿ 辅助功能：自动符合 WCAG 2.1 AA 级标准
• 多格式支持：处理 Markdown、YAML、JSON 和 TOML
• Feed 生成：自动创建 Atom 和 RSS feed
• 分析：原生 Google 和 Bing Analytics 集成
• ？主题：自定义 HTML 主题和模板支持

发展特点

• ？ CLI 工具：综合命令行界面
• Dev Server ：用于本地开发的内置 Rust 服务器
• ？热重载：开发过程中自动更新内容
• 类型安全：保证内存和线程安全
• ⚡ 异步支持：完整的异步操作能力

入门 ？

安装

添加到您的Cargo.toml ：

[ dependencies ]
ssg = " 0.0.32 "

或者通过 Cargo 安装：

cargo install ssg

基本用法

 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 用法

创建一个新站点：

 # 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 选项

选项	短的	描述	必需的
--content	-c	内容路径	是的
--template	-t	模板路径	是的
--serve	-s	服务器公共路径	是的

示例

尝试我们的示例实现：

 # 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

文档

• API文档
• 用户指南
• 贡献指南

贡献？

我们欢迎贡献！有关详细信息，请参阅我们的贡献指南：

• 行为守则
• 开发流程
• 拉取请求指南
• 问题报告

执照 ？

该项目获得双重许可：

• Apache 许可证，版本 2.0
• 麻省理工学院许可证

由您选择。

致谢

特别感谢所有帮助构建 Shokunin 的贡献者。