首页
/ Cooklang 规范项目使用教程

Cooklang 规范项目使用教程

2024-08-25 08:52:55作者:侯霆垣

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

Cooklang 规范项目的目录结构如下:

spec/
├── README.md
├── spec.md
└── examples/
    ├── basic.cook
    ├── ingredients.cook
    ├── metadata.cook
    ├── multiline.cook
    ├── quantities.cook
    ├── steps.cook
    └── tools.cook

目录介绍

  • README.md: 项目介绍文件,包含项目的基本信息和使用说明。
  • spec.md: Cooklang 的规范文档,详细描述了 Cooklang 的语法和使用规则。
  • examples/: 示例文件夹,包含多个 .cook 文件,展示了 Cooklang 的不同用法和特性。

2. 项目的启动文件介绍

Cooklang 规范项目没有传统意义上的“启动文件”,因为它主要是一个文档和示例集合。用户可以直接阅读 spec.md 文件来了解 Cooklang 的规范,并通过 examples/ 文件夹中的示例文件来学习如何编写 Cooklang 文档。

3. 项目的配置文件介绍

Cooklang 规范项目同样没有传统意义上的“配置文件”,因为它主要是一个文档和示例集合。用户不需要进行任何配置即可阅读和学习 Cooklang 的规范。


以上是 Cooklang 规范项目的基本使用教程,希望对您有所帮助。

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