Skip to main content

小书匠元数据使用说明

概述

小书匠对文章提供了元数据语法功能,只要在每篇文章的开头处,用 --- 符号包裹,包裹内容符合 yaml 语法的要求,系统就会把该数据转换成元数据。

通过元数据,可以更加细粒度控制语法开关,控制预览渲染效果,重置内置数据库字段,第三方存储数据扩展等

当在文章里提供了合法的元数据,系统就会使用该元数据值代替全局设置值。如果没有提供相应的元数据,则系统使用全局设置的值,如果全局设置的值为空,系统再使用默认值进行控制。

比如我在全局设置里打开了 html 语法功能,但在文章里设置 grammar_htmlfalse , 则 系统将在当前文章里关闭 html 语法。但在其他文章里还是会打开 html 语法。

语法开关元数据

语法开关元数据在文章设置里为true时,表示当前文档强制打开该语法,false时表示强制关闭该语法.如果没有设置对应的元数据,则使用全局设置里的语法开关。

全局设置语法开关可以到小书匠主按钮>设置>扩展语法 里进行设置。

扩展语法全局控制

扩展语法全局控制

标识 说明
grammar_toc toc 语法
grammar_abbr 缩写语法
grammar_table 表格语法
grammar_tableExtra 增强型表格语法
grammar_deflist 定义语法
grammar_emoji 表情语法
grammar_footnote 脚注语法
grammar_ins 插入语法
grammar_mark 标识语法
grammar_sub 下标语法
grammar_sup 上标语法
grammar_center 居中语法
grammar_align 对齐语法
grammar_checkbox 待办语法
grammar_mathjax 公式语法
grammar_mindmap 导图语法
grammar_flow 流程图语法
grammar_sequence 序列图语法
grammar_plot 统计图语法
grammar_code 代码格式语法
grammar_codeLinenums 代码行号
grammar_html html 语法
grammar_linkify 自动链接语法
grammar_typographer 印刷字替换语法
grammar_video 视频语法
grammar_audio 音频语法
grammar_attachment 附件语法
grammar_highlight 高亮语法
grammar_mermaid mermaid 语法
grammar_classy classy 语法
grammar_cjkEmphasis 中文强调语法
grammar_cjkRuby 中文注音语法
grammar_attrs attrs 属性语法
grammar_decorate decorate 属性语法
grammar_nunjucks nunjucks 模板语法
grammar_codeChunk codeChunk 代码语法
grammar_wavedrom 数字时间语法
grammar_plantuml plantuml 图语法
grammar_xsjimg 远程图片语法

控制预览渲染元数据

下面的元数据主要用于大部份的渲染行为。

部份元数据也可以通过 小书匠主按钮>设置>预览 界面,进行全局控制。

全局设置预览行为

全局设置预览行为

元数据 名称 值格式 备注
renderMetaTitle 是否渲染标题 布尔型 是否在正文里渲染元数据 title 里的内容
renderMetaTags 是否渲染标签 布尔型
是否在正文里渲染元数据 tags 里的内容
renderImgBlock 是否渲染块级图片 布尔型
 
renderWrapImgTitle 是否渲染块级图片标题 布尔型
 
renderAutoDetectAttachment 是否自动转换非图片扩展名为附件 布尔型
 
renderNumberedHeading 是否自动对标题进行编号 布尔型
 
renderNumberedHeadingOffset 标题编号起始值 字符串  
renderNumberedHeadingH1 一号标题编号规则 字符串 
 
renderNumberedHeadingH2 二号标题编号规则 字符串 
 
renderNumberedHeadingH3 三号标题编号规则 字符串 
 
renderNumberedHeadingH4 四号标题编号规则 字符串 
 
renderNumberedHeadingH5 五号标题编号规则 字符串 
 
renderNumberedHeadingH6 六号标题编号规则 字符串 
 
preview_previewType 预览模式 `normal`或`presentation` 用于文章在打开时,控制是否需要系统切换对应的预览界面.如果文章里没有该项元数据,或者元数据值不正确,则系统默认使用`normal`预览模式.该元数据仅控制文章打开时初始化的界面,用户依然可以通过按钮在不同预览模式间切换.

功能元数据

目前提供的功能元数据主要为控制资源上传路径设置。所谓资源,指的是使用小书匠内置的数据库管理的附件资源 的上传路径。比如图片默认的上传路径为 images/

通过元数据控制,可以达到每篇文章上传资源附件到不同的路径下。

该元数据可以通过小书匠主按钮>设置>基本>资源路径界面,进行全局控制。

全局资源路径控制

全局资源路径控制

元数据 说明 默认值
imagePath 控制上传图片的路径 images/
attachmentPath 控制上传附件的路径 attachments/
audioPath 控制上传音频的路径 audios/
videoPath 控制上传视频的路径 videos/

重置内置数据库字段

下面几个元数据将会重置数据库内的字段值。

元数据 数据库字段 说明 备注
title title 标题  
tags tagNames 标签 tag支持数组格式存储,但 tagNames 会转换成逗号分隔的字符串
cover cover 封面 暂时保留
excerpt excerpt 摘要 暂时保留
slug slug 路径 暂时保留