Wyam 开源项目教程

Wyam 开源项目教程

Wyam A modular static content and static site generator. 项目地址: https://gitcode.com/gh_mirrors/wy/Wyam

1. 项目的目录结构及介绍

Wyam 项目的目录结构如下：

Wyam/
├── src/
│   ├── Wyam.Common/
│   ├── Wyam.Core/
│   ├── Wyam.Hosting/
│   ├── Wyam.Modules.Razor/
│   ├── Wyam.Modules.Markdown/
│   └── ...
├── test/
│   ├── Wyam.Common.Tests/
│   ├── Wyam.Core.Tests/
│   └── ...
├── tools/
│   └── Wyam/
├── .gitignore
├── LICENSE
├── README.md
└── ...

目录结构介绍：

• src/: 包含项目的源代码，分为多个模块，如 Wyam.Common, Wyam.Core, Wyam.Hosting 等。
• test/: 包含项目的单元测试代码，每个模块都有对应的测试目录。
• tools/: 包含 Wyam 的可执行文件和相关工具。
• .gitignore: Git 的忽略文件配置。
• LICENSE: 项目的开源许可证文件。
• README.md: 项目的介绍文档。

2. 项目的启动文件介绍

Wyam 项目的启动文件位于 tools/Wyam/Wyam.exe。这是一个可执行文件，用于启动 Wyam 引擎并执行生成任务。

启动文件介绍：

• Wyam.exe: 这是 Wyam 的主可执行文件，可以通过命令行运行。例如：

  ./Wyam.exe --input "input_folder" --output "output_folder"
  

  该命令将指定输入目录和输出目录，Wyam 会根据配置生成静态网站。

3. 项目的配置文件介绍

Wyam 的配置文件通常是一个名为 config.wyam 的文件，位于项目的根目录或输入目录中。

配置文件介绍：

• config.wyam: 这是一个 C# 脚本文件，用于配置 Wyam 的生成过程。文件中可以定义模块、管道、输入输出路径等。

  示例配置文件内容：

  Pipelines.Add("Content",
      ReadFiles("*.md"),
      FrontMatter(Yaml()),
      Markdown(),
      WriteFiles(".html")
  );
  

  该配置定义了一个名为 "Content" 的管道，用于读取 Markdown 文件，处理前言，转换为 HTML，并写入输出目录。

通过以上配置文件，用户可以自定义 Wyam 的生成流程，以满足不同的需求。

Wyam A modular static content and static site generator. 项目地址: https://gitcode.com/gh_mirrors/wy/Wyam