9 个版本

0.5.9 2023 年 8 月 28 日
0.5.8 2022 年 12 月 24 日
0.5.5 2022 年 11 月 20 日

#430 in 网络编程

MIT 许可证

18KB
286

翻找

翻找是一个简单的网络框架。它将 Markdown 文件转换为纯 HTML。

⚠️ 翻找尚未完全准备好用于生产环境!它相当稳定,但需要更多的错误处理。您可以使用它,但请注意,如果您遇到错误,可能更难调试。我使用它来构建我的 个人网站

功能

  • ⚡️ 极快
  • ✨ 设计简单
  • 📄 Markdown 和 HTML
  • 💔 零 JavaScript
  • 🧑‍💻 可定制

安装

请确保您已经 安装了 cargo 并按如下方式安装 rumage

cargo install rumage

或者检查版本

使用方法

用于构建

rumage build

页面

翻找支持 Markdown 和 HTML 页面。创建一个 index.mdindex.html 以创建主页。

同时在上部添加一些属性以添加标题和描述。默认情况下,您需要填写这些内容,否则它们将被 %title%%description% 替换。 (这将在不久后解决),

index.md

---
title: Homepage
description: Cool page
---

# Homepage
lorem

如果您想对属性进行更多操作,请参阅 标题标签

您可以在 Markdown 文件中包含 HTML,但不能在 HTML 文件中包含 Markdown。 (这将在不久后解决)

样式

要将样式添加到您的网站,请将 style.css 添加到您的源文件夹中。翻找将自动将其拾取并在所有页面上包含它。

标题标签

默认情况下,标题标签包含可定制的标题和描述属性、favicon 和样式表。

favicon 的默认名称为 favicon.png,全局样式表为 style.css

要自定义每个页面的标题,请将 _head.html 添加到您的源文件夹中。

您可以在 html 中使用 %property% 以替换来自 Markdown 页面的自定义值。

示例

_head.html

<head>
    <title>%title</title>
    <meta name="description" content="%description%" />
    <meta name="tags" content="%tags%" />
</head>

index.md

---
title: Home
description: The homepage
tags: tech, typescript, web, rust
---

# Hello world

路由

路由非常简单,所有文件都代表一个路由。

自定义组件

计划中

要添加导航栏或页脚,创建一个 _nav.html_nav.md 用于导航栏,以及 _footer.html_footer.md 用于页脚。

如果这些文件存在于源文件夹中,所有页面将默认包含导航栏和页脚。要禁用此功能,请在文件顶部添加 nav: falsefooter: false

---
nav: false
footer: false
---

依赖项

~11-22MB
~346K SLoC