Skip to content

IInaho/siyuan-plugin-frontmatter-card

Repository files navigation

Frontmatter卡片渲染插件

简介

这是一个思源笔记插件,用于将frontmatter格式的内容渲染为美观的卡片样式。

功能特点

  • 🎨 自动识别: 自动识别文档中的frontmatter格式内容(+++ ... +++
  • 🎯 卡片实时渲染: 将frontmatter内容渲染为美观的卡片样式
  • 💾 实时编辑: 通过编辑框改原始md文本进行实时渲染
  • 🌐 多语言支持: 支持中英文界面
  • 🖱️ 一键切换: 通过快捷键快速启用/禁用卡片渲染
  • 📱 响应式设计: 适配不同屏幕尺寸
  • 🔄 模式切换: 在查看和编辑模式间无缝切换

安装方法

  1. 下载插件压缩包
  2. 解压到思源笔记的插件目录:工作空间/data/plugins/
  3. 重启思源笔记
  4. 在插件管理器中启用插件

使用方法

基本使用

  1. 启用插件: 在插件管理器中启用插件
  2. 添加frontmatter: 在文档中添加frontmatter格式内容:
+++
authors = ["lzy"]
title = "Upx一款高效的二进制压缩工具"
date = "2025-10-16 10:29:00"
description = "Upx一款高效的二进制压缩工具"
tags = [
  "linux",
]
categories = [
  "技术文档"
]
+++
  1. 自动渲染: 插件会自动将frontmatter内容渲染为卡片样式

交互编辑

  1. 进入编辑模式: 支持交互式编辑,通过编辑按钮,弹出文本对话框,进行编辑原始文本
  2. 实时保存渲染: 原始文本实时保存,并重新渲染

视觉反馈:

  • 输入框清晰可见,带有焦点指示器
  • 悬停效果显示编辑提示

快捷键

  • Ctrl+Shift+F (Windows/Linux)
  • Cmd+Shift+F (macOS)

支持的frontmatter字段

字段名 类型 说明
title 字符串 文章标题
authors 数组/字符串 作者信息
date 字符串 发布日期
description 字符串 文章描述
tags 数组 标签列表
categories 数组 分类列表

示例

输入

+++
authors = ["张三", "李四"]
title = "思源笔记插件开发指南"
date = "2025-10-16 10:29:00"
description = "详细介绍如何开发思源笔记插件,包括插件结构、API使用、调试技巧等"
tags = [
  "插件开发",
  "思源笔记",
  "教程"
]
categories = [
  "技术文档",
  "开发指南"
]
+++

输出

插件会将上述内容渲染为一个美观的卡片,包含:

  • 标题:思源笔记插件开发指南
  • 作者:张三, 李四
  • 描述:详细介绍如何开发思源笔记插件...
  • 标签:插件开发、思源笔记、教程(显示为灰色标签)
  • 分类:技术文档、开发指南(显示为蓝色分类)

注意事项

插件只处理使用+++包围的frontmatter内容

反馈与支持

如有问题或建议,请在GitHub上提交Issue。

许可证

MIT License

About

思源文字卡片插件

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors