制作静态网站的得力助手！

项目描述

这是一个用Rust编写的极简静态网站生成器，灵感来自Hugo。网站的HTML模板和文件布局基于HTML5 Boilerplate。

示例

您可以在https://softannalee.neocities.org上查看使用md_puppy生成的网站示例

安装

先决条件

• Rust（2021版）

如何安装

要安装，首先安装Rust和Cargo。然后使用以下命令之一；

cargo安装 md_puppy

或者

cargo安装 --githttps://github.com/SoftAnnaLee/md_puppy

从源代码编译

首先克隆此存储库，然后使用以下代码示例中的cargo build或cargo install：

git clone https://github.com/SoftAnnaLee/md_puppy
cd md_puppy
cargo install --path "$(pwd)"

用法

使用md_puppy help显示以下信息；

md_puppy 1.0.0
AnnaLee <@SoftAnnaLee>
A minimal static site generator

USAGE:
    md_puppy [OPTIONS] [SUBCOMMAND]

OPTIONS:
    -c, --completions <SHELL>    Generate a SHELL completion script and print to stdout [possible
                                 values: bash, zsh, fish, power-shell, elvish]
    -h, --help                   Print help information
    -V, --version                Print version information

SUBCOMMANDS:
    build    Process all files in the 'content/' folder and parse into a website
    help     Print this message or the help of the given subcommand(s)
    init     Download and initalize directories needed for website
    new      Create a new file within the 'content/' folder with default frontmatter

• md_puppy init用于初始化一个目录，其中包含开始创建网站所需的文件。
• md_puppy new <FILEPATH>用于创建带有预配置frontmatter的空白文件。所有页面都将创建在content/目录中，以及任何添加到文件路径的子目录。
• md_puppy build用于编译content/目录中的Markdown文件，并将完整的网站放置在site/目录中。
• md_puppy --completions <SHELL>用于生成shell补全，并将输出到标准输出。我建议查找如何将shell补全添加到您的个人shell中，以利用此功能。

该网站生成器只有一个主题，我将其用于我的个人网站。我免费提供使用和复制以供重用；但我强烈建议您自己个性化它。它仅包含HTML和CSS，因此应该很容易根据您自己的品味进行修改。

还有一个config.toml，它具有以下默认配置；

# Name for the website across all pages
site_name: md_puppy site
# Url to pull the static site content/theme
static_url: https://github.com/SoftAnnaLee/md_puppy/releases/download/static/static.zip
# Url to pull boilerplate
boilerplate_url: https://raw.githubusercontent.com/SoftAnnaLee/md_puppy/main/template/boilerplate.html
# Base Url used for relative links
base_url: https://www.example.com/

如果您想使用不同的HTML模板或不同的主题以提取到static_url，则可以在那里更改这些详细信息。

目的

我是一名初学者程序员，正在自学Rust并完成项目。所以这个项目相当简单，主要是围绕我个人的使用场景设计的（运行个人博客和网站）。如果您需要添加任何功能，我可以根据要求进行，但很遗憾无法保证。欢迎您fork或提交pull请求！