STRAWBERRY MILK

一个由 Rust 编写的简单、甜美的工具，用于编译您的网页内容。

关于

由于我也是一个作者和艺术家，我在想如何编写一个将包含 Markdown 内容的文件转换为网站的程序。 草莓牛奶 就是这个工具。您初始化一个新的项目，用 Markdown 编写内容，运行 草莓牛奶，然后 Voilà！您就拥有了一个包含您内容的漂亮且闪亮的新网页，它已为您设置样式，准备好展示给世界！

示例项目

您可以在 这里 查看一个现场部署的 草莓牛奶 项目。

构建

工具

您需要安装以下工具并使其可用

• Rust
• Git

步骤

• 1.) 获取源代码

$ git clone https://github.com/iamtheblackunicorn/strawberrymilk.git

• 2.) 切换目录

$ cd strawberrymilk

• 3.) 构建源代码

$ cargo build --release

安装

将可执行文件 strawberrymilk/target/release/strawberrymilk 移动到您存储二进制可执行文件的目录。如果您使用 Linux 或 Mac OSX，可能需要更改权限，如下所示： chmod a+x strawberrymilk。如果您已安装 Rust 的包管理器，从终端窗口运行 cargo install strawberrymilk 也应安装 草莓牛奶。

使用方法

命令行使用

要编译您的项目，只需在命令行上运行此命令

$ strawberrymilk yourprojectdir

yourprojectdir 表示您的项目路径。

创建新项目。

要创建新项目，请运行以下命令

$ strawberrymilk new myproject

这将创建一个名为 myproject 的新文件夹。您的项目文件结构将类似于以下内容

myproject
├── config.json
└── content
    └── 01.markdown

文件 config.json 将包含以下内容

{
  "styles": "https://blckunicorn.art/assets/generic/strawberrymilk.css",
  "content": "content",
  "name": "myproject",
  "output": "index.html"
}

• name: 您的项目叫什么名字？
• content: 哪个子目录包含项目的 Markdown 文件？
• styles: 要使您的页面看起来更美观，您需要一个样式表。从其他地方加载它。草莓牛奶 不支持本地样式表。
• output: 输出 HTML 文件应命名为什么？
• use_template: 如果您想使用 Liquid 模板，请将此设置为 true 或 false。
• template_path：该字段告诉草莓牛奶您的模板在项目中的位置。

接下来，打开位于content文件夹中的01.markdown文件。（请注意，该文件夹的名称必须与配置文件中的content字段相同。）它将包含如下内容

# YOUR PROJECT
Your awesome content goes here.

如果您正在使用模板，所有来自配置文件的变量都可以在{{ project.variable }}下使用。variable代表您的config.json文件中的字段名。

{% for page in pages %}
<br/>
<div class="content">
  {{ page.content }}
</div>
<br/>
{% endfor %}

$ strawberrymilk .

on: [push]
name: Strawberry Milk Project CI
jobs:
  build_and_test:
    name: Strawberry Milk Project CI
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v2
      - uses: actions-rs/toolchain@v1
        with:
          toolchain: stable
      - uses: actions-rs/cargo@v1
        with:
          command: build
          args: --release
      - uses: actions-rs/cargo@v1
        with:
          command: run
          args: .
      - name: Deploy
        uses: JamesIves/[email protected]
        with:
          branch: gh-pages
          folder: build