首页
/ Pretzel 技术文档

Pretzel 技术文档

2024-12-28 10:09:22作者:滑思眉Philip

1. 安装指南

Pretzel 是一个面向 .NET 开发者和 Windows 用户的简单、可插拔的站点生成工具。以下是安装 Pretzel 的步骤:

  • 确保您的系统已安装 .NET Core SDK。

  • 打开命令提示符或 PowerShell。

  • 运行以下命令安装 Pretzel:

    dotnet tool install -g pretzel
    

2. 项目使用说明

Pretzel 提供了几个主要的命令来创建和生成站点:

创建站点

使用 create 命令创建新站点的文件夹结构:

pretzel create

如果需要在特定文件夹中创建站点,可以将路径作为参数传递:

pretzel create C:\path\to\folder

生成站点

使用 bake 命令生成站点。以下是一些使用 bake 命令的示例:

  • 扫描当前目录并检测要处理的内容:

    pretzel bake
    
  • 扫描特定文件夹并解析内容:

    pretzel bake C:\path\to\folder
    
  • 明确指定输入(应支持根据找到的文件推断输入):

    pretzel bake --engine liquid
    

本地测试站点

使用 taste 命令本地测试站点。以下是一些使用 taste 命令的示例:

  • 本地测试站点:

    pretzel taste
    
  • 指定服务端口(默认为 4000):

    pretzel taste --port 5000
    
  • 停止站点服务,按 q 键。

3. 项目API使用文档

Pretzel 的 API 使用文档可以在项目 wiki 上找到。由于项目已被归档,具体 API 文档的详细信息可能不完全可用。建议查看项目源代码或现有插件以获取更多关于 API 的信息。

4. 项目安装方式

Pretzel 的安装方式已在“安装指南”部分详细介绍。您可以通过以下命令全局安装 Pretzel 工具:

dotnet tool install -g pretzel

确保您的系统已安装 .NET Core SDK,然后按照上述步骤操作即可完成安装。

登录后查看全文
热门项目推荐

项目优选

收起