eastwind-blogger

Crates.ioeastwind-blogger
lib.rseastwind-blogger
version2.3.2
sourcesrc
created_at2023-03-01 06:09:58.445697
updated_at2023-11-08 07:28:27.4589
descriptionA Rust implementation for Eastwind Blogger
homepagehttps://github.com/zhongdongy/docker-blogger/
repositoryhttps://github.com/zhongdongy/docker-blogger/
max_upload_size
id797785
size307,767
Zhongdong Yang (zhongdongy)

documentation

README

Eastwind Blogger

一个使用全缓存实现的相当简单却高效的静态博客服务器程序。

配置和部署

示例配置

public:
  home_post: welcome
site:
  hostname: "127.0.0.1:5000"
  enable_https: false
  site_name: 那阵东风
  site_email: zhongdongy@dongs.xyz
  site_slogan: '由 Eastwind Blogger 驱动'
  gravatar_proxy: https://127.0.0.1/gavatar/
  baidu_site_verification: "" # 百度站长平台的 HTML 标签验证码方法
  baidu_site_analysis: "" # 百度统计的 ID
  google_tag: "" # Google Analysis 的 ID
  beian:
    enabled: true
    icp_id: 粤ICP备XXX号-1
    beian_id: 粤公安网备XXX号

撰写文章

您可以使用 Markdown 和 LaTeX(使用 MathJax 进行渲染)撰写博文。为了提供标签分类等丰富的博文索引服务,您还可以在每篇博文的报头增加一段元数据:

---
title: 沁园春·雪
author: 毛泽东
author_avatar: https://xxxxx/
author_email: "mzd@example.com"
description: ""
keywords: 
- 诗词
created_at: "1936-02-01"
updated_at: "1936-02-01"
tags:
- 毛泽东诗词
permanent_link: 
renderer_params: 
- enable-toc
- content-serif
- content-justify
redirect: "/post/abc/"
---

这段元数据遵循 YAML 语法,其中:

  • title 对应了文章的标题
  • author 指博文的作者
  • author_avatar(可选)是用户头像的 URL
  • author_email(可选)指博文作者的邮箱,用于获取 GRAVATAR 图像
  • description(可选)简单的博文描述信息
  • keywords(可选)博文的关键字
  • created_at(可选)指博文创作的时间,如“YYYY-mm-dd”
  • updated_at(可选)指博文修改的时间,如“YYYY-mm-dd”
  • tags (可选)指博文的标签,您可以为同一篇博文提供任意数量的标签
  • permanent_link(可选)是您手动指定的固定访问链接,没有指定则不会生成
  • renderer_params(可选)是渲染博文时的指令参数,您可以使用:
    • enable-toc:显示文章索引目录 TOC
    • content-serif:使用衬线字体 (Noto Serif SC) 渲染博文内容
    • content-justify:让文字两端对齐
    • filter-grayscale:整个页面都将被渲染为黑白灰阶模式
  • redirect (可选)可以给出一个地址(需要包含起始的/),页面加载后会自动重定向到给定页面

注意:

  • 如果没有提供 created_atupdated_at,那么会默认使用今日今时作为缺省值。

为了丰富读者的阅读体验,您可以使用 Markdown 扩展语法中的脚注来实现。

此外,从 v2.3.0 版本开始,您可以使用 Obsidian 兼容的语法来编写 Callout 了!参阅 Callouts

开发

如果您在中国大陆扩展开发,建议您打包时使用 Cargo 的镜像以加速访问:

docker build -t test:latest --build-arg enable_cargo_mirror=1 --progress=plain .

如果修改了 Sass 样式表,可以通过此命令重新生成 CSS 样式表:

sass --watch --update --source-map static/css:static/css
sass --no-source-map static/css:static/css

如果希望使用 eastwind-blogger 程序而不依赖其他文件,可以在安装时指定:

cargo install --no-default-features --features bundled

调试时, 可以使用下列命令查看效果:

cargo run -- -s -p 18888
Commit count: 113

cargo fmt