Statiq Framework 使用教程

Statiq Framework 使用教程

Statiq.Framework A flexible and extensible static content generation framework for .NET. 项目地址: https://gitcode.com/gh_mirrors/st/Statiq.Framework

1. 项目介绍

Statiq Framework 是一个灵活且可扩展的静态内容生成框架，专为 .NET 平台设计。它是 Wyam 项目的进化版，旨在帮助开发者轻松创建和管理静态网站、文档和其他静态内容。Statiq Framework 提供了丰富的模块和插件，支持自定义内容处理管道，适用于各种静态内容生成需求。

2. 项目快速启动

2.1 安装 Statiq Framework

首先，确保你已经安装了 .NET SDK。然后，通过 NuGet 安装 Statiq Framework：

dotnet new console -n MyStatiqProject
cd MyStatiqProject
dotnet add package Statiq.App

2.2 创建基本配置文件

在项目根目录下创建一个 Program.cs 文件，并添加以下代码：

using System;
using Statiq.App;
using Statiq.Common;
using Statiq.Core;

namespace MyStatiqProject
{
    class Program
    {
        static async Task<int> Main(string[] args) =>
            await Bootstrapper
                .Factory
                .CreateDefault(args)
                .RunAsync();
    }
}

2.3 添加内容文件

在项目根目录下创建一个 input 文件夹，并在其中添加一些 Markdown 文件，例如 index.md：

# 欢迎使用 Statiq Framework

这是一个使用 Statiq Framework 生成的静态网站。

2.4 运行项目

在终端中运行以下命令来生成静态内容：

dotnet run

生成的静态文件将位于 output 文件夹中。

3. 应用案例和最佳实践

3.1 静态网站生成

Statiq Framework 非常适合用于生成静态网站。你可以使用 Markdown 编写内容，并通过配置文件定义内容处理管道，生成最终的 HTML 文件。

3.2 文档生成

对于文档生成，Statiq Framework 提供了强大的支持。你可以将多个 Markdown 文件组织成一个文档站点，并通过主题和模板自定义文档的外观。

3.3 博客生成

使用 Statiq Framework，你可以轻松生成博客。通过配置文件，你可以定义博客的分类、标签、归档等功能，并自动生成博客页面。

4. 典型生态项目

4.1 Statiq Web

Statiq Web 是基于 Statiq Framework 构建的静态网站生成器，专注于生成现代化的静态网站。它提供了丰富的主题和插件，支持博客、文档、个人网站等多种应用场景。

4.2 Statiq Docs

Statiq Docs 是一个专门用于生成文档的工具，基于 Statiq Framework。它支持多语言、版本控制、搜索等功能，非常适合用于生成项目文档。

4.3 Statiq Blog

Statiq Blog 是一个专注于生成博客的工具，基于 Statiq Framework。它提供了博客分类、标签、归档等功能，并支持自定义主题和模板。

通过以上模块，你可以快速上手并深入了解 Statiq Framework 的使用和应用场景。

Statiq.Framework A flexible and extensible static content generation framework for .NET. 项目地址: https://gitcode.com/gh_mirrors/st/Statiq.Framework