`），[`oxc_minifier`](https://crates.io/crates/oxc_minifier/0.95.0) `0.95`（JS，mangle + DCE）和 [`lightningcss`](https://crates.io/crates/lightningcss/1.0.0-alpha.71) `1.0.0-alpha.71`（CSS）。递归遍历会处理 `site_dir` 下所有深度的 `.html`、`.css` 和 `.js` 文件。 |

| **供应链** | 每次构建时通过 `SbomPlugin` 自动生成 `CycloneDX` 1.5 SBOM (`sbom.cdx.json`)，列出编译器版本、依赖树和许可证元数据 |

| **开发者体验** | CSS 热重载，通过 WebSocket 实现的浏览器错误覆盖层，带有更改分类的文件监视 |

| **WebAssembly** | ssg-core + ssg-wasm 使用 wasm-bindgen 编译为 `wasm32-unknown-unknown` |

| **Islands** | 支持延迟水合的 Web Components |

### 为什么选择 SSG？

| 能力 | SSG | Hugo | Zola | Astro |

|---|---|---|---|---|

| Agentic AI pipeline | 是 | 否 | 否 | 否 |

| 多语言可读性 | 是 | 否 | 否 | 否 |

| 自动生成 OG 图像 | 是 | 否 | 否 | 插件 |

| 内置 WCAG 验证 | 是 | 否 | 否 | 否 |

| CSP/SRI 自动提取 | 是 | 否 | 否 | 插件 |

| axe-core CI 门控 | 是 | 否 | 否 | 否 |

| WebAssembly 目标 | 是 | 否 | 否 | N/A |

| 95% CI 覆盖率下限 | 是 | 否 | 否 | 否 |

| 零不安全代码 | 是 | 是 | 是 | N/A |



## 命令行接口


```
Usage: ssg [OPTIONS]



Options:

  -f, --config       Configuration file path

  -n, --new          Create new project

  -c, --content       Content directory

  -o, --output        Output directory

  -t, --template      Template directory

  -s, --serve         Start development server

  -w, --watch              Watch for changes and rebuild

  -j, --jobs            Rayon thread count (default: num_cpus)

      --max-memory     Peak memory budget for streaming (default: 512)

      --ai-fix             Run agentic AI pipeline to fix content readability

      --ai-fix-dry-run     Preview AI fixes without writing changes

      --validate           Validate content schemas and exit

      --drafts             Include draft pages in the build

      --deploy     Generate deployment config (netlify, vercel, cloudflare, github)

  -q, --quiet              Suppress non-error output

      --verbose            Show detailed build information

  -h, --help               Print help

  -V, --version            Print version
```




## 库用法



最小化 pipeline


```
fn main() -> Result<(), ssg::error::SsgError> {

    ssg::run()

}
```






自定义插件


```
use ssg::plugin::{Plugin, PluginContext, PluginManager};

use ssg::error::SsgError;

use std::path::Path;



#[derive(Debug)]

struct LogPlugin;



impl Plugin for LogPlugin {

    fn name(&self) -> &str { "logger" }

    fn after_compile(&self, ctx: &PluginContext) -> Result<(), SsgError> {

        println!("Site compiled to {:?}", ctx.site_dir);

        Ok(())

    }

}



fn main() -> Result<(), SsgError> {

    let mut pm = PluginManager::new();

    pm.register(LogPlugin);

    pm.register(ssg::plugins::MinifyPlugin);



    let ctx = PluginContext::new(

        Path::new("content"),

        Path::new("build"),

        Path::new("public"),

        Path::new("templates"),

    );

    pm.run_after_compile(&ctx)?;

    Ok(())

}
```






内容 schema 验证

创建 `content/content.schema.toml`：


```
[[schemas]]

name = "post"



[[schemas.fields]]

name = "title"

type = "string"

required = true



[[schemas.fields]]

name = "date"

type = "date"

required = true



[[schemas.fields]]

name = "draft"

type = "bool"

default = "false"
```


在 frontmatter 中带有 `schema = "post"` 的页面将在编译时进行验证。运行 `ssg --validate` 进行仅 schema 检查。





可读性审核


```
use ssg::llm::{LlmPlugin, LlmConfig};

use std::path::Path;



let report = LlmPlugin::audit_all(Path::new("content"), 8.0).unwrap();

println!("{}/{} files pass grade 8.0", report.passing, report.total_files);



// Multilingual: French content uses Kandel-Moles automatically

// when frontmatter contains `language: fr`
```






OG 图像生成


```
use ssg::og_image::generate_og_svg;



let svg = generate_og_svg("My Page Title", "My Site", "#1a1a2e", "#ffffff");

std::fs::write("og-card.svg", svg).unwrap();

// 1200x630 SVG social card ready for og:image
```






## 示例

运行任意示例：


```
cargo run --example basic

cargo run --example blog
```


| 示例 | 用途 |

| :--- | :--- |

| `basic` | 包含 SEO、搜索和融合转换的最小站点 |

| `quickstart` | 10 行代码实现脚手架和构建 |

| `multilingual` | 包含 hreflang 和特定于区域设置站点地图的多语言站点 |

| `plugins` | 带有 `DepGraph` API 的完整插件 pipeline 演示 |

| `blog` | 符合 EAA 标准的、无障碍优先且带有双重 feed 的博客 |

| `docs` | 带有 schema 验证和语法高亮的文档门户 |

| `landing` | 带有 CSP 加固的零 JS 落地页 |

| `portfolio` | 带有 JSON-LD 和 Atom feed 的开发者作品集 |



## 开发


```
make              # check + clippy + test

make test         # run all tests

make bench        # run Criterion benchmarks

make lint         # lint with Clippy

make format       # format with rustfmt

make deny         # supply-chain audit

make doc          # build API documentation

make a11y         # run pa11y accessibility audit

make clean        # remove build artifacts
```


### CI

| 工作流 | 触发条件 | 用途 |

| :--- | :--- | :--- |

| `ci.yml` | push, PR | fmt, clippy, test (3 OS), 覆盖率 (95% 下限), cargo-deny |

| `document.yml` | push 到 main | 构建并将 API 文档部署到 GitHub Pages |

| `release.yml` | tag `v*` | 跨平台二进制文件、GHCR 容器、crates.io、AUR |

| `scheduled.yml` | 每周, tag | 多操作系统可移植性、pa11y a11y、`CycloneDX` SBOM、基准测试 |

| `visual.yml` | PR | Playwright 屏幕截图（3 种视口）+ axe-core WCAG 2.2 AA |

| `wasm.yml` | push, PR | 为 wasm32 构建并测试 ssg-core + ssg-wasm |

| `readability-gate.yml` | PR | 对文档和内容进行 Flesch-Kincaid 审核 |

有关签名提交和 PR 指南，请参阅 [CONTRIBUTING.md](CONTRIBUTING.md)。



## 安全性



安全保证与合规性

- 整个代码库均遵循 `#![forbid(unsafe_code)]`
- CSP 构建时提取：所有内联样式和脚本均至带有 SRI 哈希的外部文件中。零 `unsafe-inline`
- 通过 `..` 检测和 symlink 拒绝来防止路径遍历
- 文件大小限制和目录深度边界
- `cargo audit` 零安全通报
- `cargo deny` -- 许可证、通报、禁令和来源检查
- 生成带有 Sigstore 证明的 `CycloneDX` SBOM 作为发布产物
- 所有源文件上的 SPDX 许可证头
- 通过 SSH ED25519 强制执行签名提交

有关完整的 CSP 安全架构，请参阅 [docs/whitepaper/csp-without-compromise.md](docs/whitepaper/csp-without-compromise.md)。





所有 38 个模块

| 模块 | 用途 |

| :--- | :--- |

| `accessibility` | WCAG 2.2 AA 检查器、ARIA 验证、装饰性图像检测、目标大小 + 焦点外观检查、合规性矩阵 |

| `ai` | AI 就绪钩子、alt 文本验证、`llms.txt` / `llms-full.txt` 生成 |

| `assets` | 资源指纹识别和 SRI 哈希生成 |

| `cache` | 用于增量构建的内容指纹识别 (FNV-1a) |

| `cmd` | CLI 参数解析、`SsgConfig`、输入验证 |

| `content` | 内容 schema、`ContentValidationPlugin`、`--validate` |

| `csp` | 将内联样式/脚本提取至外部文件的 CSP 构建时提取 |

| `depgraph` | 用于增量重建的页面到模板依赖图 |

| `deploy` | Netlify、Vercel、Cloudflare Pages、GitHub Pages 适配器 |

| `drafts` | 草稿内容过滤 |

| `frontmatter` | Frontmatter 提取和 `.meta.json` 附属文件 |

| `fs_ops` | 带有遍历预防的安全文件操作 |

| `highlight` | 代码块的语法高亮 |

| `i18n` | Hreflang 注入、特定于区域设置的站点地图、语言切换器 |

| `image_plugin` | 支持 WebP 的响应式 ``、srcset 生成 |

| `islands` | 支持延迟水合的 Web Components |

| `livereload` | WebSocket 实时重载、CSS HMR、浏览器错误覆盖层 |

| `llm` | 本地 LLM pipeline (Ollama)、多语言可读性评分、agentic 修复 |

| `logging` | 结构化日志配置 |

| `markdown_ext` | GFM 表格、删除线、任务列表 |

| `og_image` | 自动生成的 OG 社交卡片 SVG |

| `pagination` | 用于列表页面的分页插件 |

| `pipeline` | 构建编排、插件注册、`RunOptions` |

| `plugin` | 带有生命周期钩子的 `Plugin` trait、`PluginManager`、`PluginCache` |

| `plugins` | `MinifyPlugin`、`ImageOptiPlugin`、`DeployPlugin` |

| `postprocess` | 站点地图、RSS、Atom、manifest、HTML 后处理修复 |

| `process` | 目录创建和站点处理 |

| `scaffold` | 项目脚手架 (`ssg --new`) |

| `schema` | 用于配置的 JSON Schema 生成器 |

| `search` | 全文搜索索引、模态 UI、28 种区域设置翻译 |

| `seo` | `SeoPlugin`、`JsonLdPlugin`、`CanonicalPlugin`、`RobotsPlugin` |

| `server` | 开发 HTTP 服务器 |

| `shortcodes` | youtube、gist、figure、admonition 扩展 |

| `stream` | 高性能流式文件处理器 |

| `streaming` | 针对大型站点的内存预算流式编译 |

| `taxonomy` | 标签和分类索引生成 |

| `template_engine` | `MiniJinja` 模板引擎集成 |

| `template_plugin` | `MiniJinja` 模板渲染插件 |

| `walk` | 共享的有界目录遍历器 |

| `watch` | 带有更改分类的基于轮询的文件监视器 |





## 许可证

根据您的选择，受 [Apache 2.0](https://www.apache.org/licenses/LICENSE-2.0) 或 [MIT](https://opensource.org/licenses/MIT) 双重许可。

有关发布历史，请参阅 [CHANGELOG.md](CHANGELOG.md)。

返回顶部