Yoctolio

这个项目是什么

这是一个简化版的静态站点生成器，目的是使用从csv文件收集的信息生成简单的单页作品集。

入门指南

安装

使用Cargo： cargo install yoctolio

初始化项目

安装yoctolio后，您可以通过运行 yoctolio init 来初始化一个新的项目。

配置好一切后，您可以简单地运行 yoctolio build 来编译您的网站。

配置

添加视频内容

要向您的作品集添加内容，首先需要在以下路径创建一个文件： config/config.txt

以及包含以下内容的 config/tags.txt 文件

1, directing
2, editing

单词 directing 和 editing 可以更改，只要它们的id（名称前的数字）是唯一的，就可以添加任何标签。

在这个文件中，您现在可以按每节添加一行到作品集索引页

节名称,节名称的文件名.txt

Yoctolio将生成一个名为 节名称 的部分，您希望包含在这个部分中的视频需要列在您定义的文件中。在这种情况下，config/file_name_of_the_section.txt

要添加视频，您需要遵循以下模式

视频名称,youtube_url,标签编号,年份,描述

其中

• 视频名称 是不言自明的
• youtube_url 是完整的youtube网址示例： https://www.youtube.com/watch?v=79T8c0vW0ik
• 标签 视频的标签id，要使用多个标签，请在两个标签之间添加 -，例如 1-3
• year 生产年份示例：2021
• description 简短说明，此字段为可选，可以省略。

修改模板

默认模板在项目仓库中可见。要创建自己的模板，只需创建一个包含index.html的templates文件夹，它将被默认使用。

添加页面

如果您想要添加另一个页面，可以在以下路径创建一个文件夹：templates/pages，其中包含任何要包含在您的作品集中的HTML页面。

添加资源

每次您想要在项目中包含CSS、JS、图片或其他资源时，您只需在以下路径创建一个文件夹：templates/assets，在编译过程中，该文件夹的内容将被复制到public/assets。

添加部分

部分是一个可以轻松在不同的页面和模板中重复使用的HTML片段，对于头部、页脚、导航等非常有用。

要将部分添加到您的作品集中，您需要创建一个名为templates/partials的文件夹，然后在其中创建任何HTML文件。要从index.html页面调用部分，只需包含以下片段：{{!partial_name}}。

因此，如果您创建templates/partials/footer.html，则可以通过在任何模板中使用{{!footer}}来调用它。

实时预览

当您在模板上工作时，您可能希望自动重新生成网站，因为手动操作可能会很快变得烦人。

为此，我通常使用entr，如下所示：

ls templates/*| entr yoctolio build