基于 Trilium 笔记系统自动生成博客使用手册 Shmaur 版

转载原作者主题使用手册:Trilium博客主题:Ankia 使用指南 - 东东的小黑盒

基于原作者进行的设计改造。以下原文来自原作者,基于原作者基础新增了我的配置

更新记录:Ankia&shmaur-Theme 更新记录 - shmaur

本博客主题主题预览:shmaur

本博客主题使用方式:使用手册,转载于 Ankia-Theme 内容修改

一、主题特点

相较于 Trilium 自带的分享功能,本主题有以下特点

  • 拥有一套完整的博客系统

  • 博客界面简洁

  • 完美适配的移动端界面

  • 优化正文阅读体验

  • 增加正文目录,适配移动端(新增)

  • 支持一键发布博客

  • 支持代码高亮

  • 诸多可配置项

  • 支持博客图片点击放大缩小(新增)

  • 新增文章作者

  • SEO 站点建设

image.png

image.png

二、配置指南

2.1 下载

下载地址:https://github.com/Shmaur/Ankia-shmaur-Theme-trilium/releases/tag/release

2.2 安装

1、按以下步骤将主题导入 Trilium:

2、在你想存放博客的笔记下方右键

3、选择【Import into note】

4、在弹出的窗口中选择第一步中下载的 zip 包,将【Options】下的「Safe import」取消勾选

5、点击【Import】

6、导入成功的话笔记中会出现以下目录结构的笔记:

  • myblog
    • 说说
    • 文章分类
    • 推荐阅读
    • 导航
    • 标签
    • 首页
    • 未发表
    • Ankia&Shmaur-Theme

注:以上笔记为博客基础的结构,请勿删除!

在 myblog 中点击分享,然后点击分享连接就可以看到效果。

image.png

三、配置

3.1 基础配置

博客的所有配置均以 Trilium 属性的形式存在,在【我的博客】笔记中修改以下属性的值即可进行配置。

#siteName = xxx              // 博客的名称,会在浏览器标签页和导航栏中显示
#blogStartTime = xxx         // 博客的开始时间,会在 footer 中显示博客运行时间
#shareDescription= xxx       // 博客的简介,用于生成网页 meta 信息
#siteKeywords = xxx          // 网站关键词
#motto = xxx                 // 座右铭,会在右侧博主信息中展示
#bloggerName = xxx           // 博主的昵称,会在右侧博主信息中展示
#siteDescription = xxx       // 网站 SEO 使用 (新增)
#record = xxx                // 备案号 (新增)
#recordLinkrecordLink = xxx  // 公安验证网址(https://beian.miit.gov.cn/#/Integrated/index) (新增)
#announcement = xxx          // 网站公告
#mailLink= xxx               // 邮箱地址
#ishomepageBG=false          // 背景图片是否显示,默认不显示,如果需要显示将属性改成 true(新增)
image.png

3.2 更换博客头像

将【我的博客→Ankia&Shmaur-Theme→imgs】下的“logo”替换为自己的头像即可。作用位置如下图

image.png

3.3 更换主页背景

将【我的博客→Ankia&Shmaur-Theme→imgs】下的“主页背景”替换为自己喜欢的背景即可。

#ishomepageBG=false // 默认不显示,需要显示将 false 改成 true

3.4 社交信息

本主题支持以下几个社交信息展示,默认关闭,填入对应属性和主页链接即可在自动开启。

#githubLink = xxx         // github
#mailLink = xxx           // 邮箱
#RSSLink = xxx            // RSS地址,示例:./feed 
#zhihuLink = xxx          // 知乎
#sspaiLink = xxx          // 少数派
#doubanLink = xxx         // 豆瓣
#netEaseCloudLink = xxx   // 网易云音乐
#bilibiliLink = xxx       // 哔哩哔哩
#telegramLink=xxx         // telegram

自建 RSS 步骤,我做了相关调整,详细点击: 自建 RSS 并通过 docker 部署网站地图 | shmaur

image.png

3.5 开启评论(可选)

本主题默认使用 twikoo 评论系统,进行配置前需要先部署,部署方法见:快速上手 | Twikoo 文档我用的是最新版本,部署完成后添加以下属性即可:

#enableTwikoo   // 开启 twikoo 评论
#envId = xxx    // twikoo 的环境 id

开启后在主面板会显示【最新评论】模块,如果不需要此功能,请在“我的博客”中添加 #disableLatestCommentPane 标签


image.png

3.6 开启文章阅读量统计(可选)

#enableVisitors   // 开启文章阅读量统计(需要先部署 twikoo)
image.png

3.7 开启赞赏功能(可选)

添加以下属性以开启赞赏功能

#enableReward     // 开启赞赏功能后需要将【我的博客→Ankia&Shmaur-Theme→imgs】路径下的”支付宝收款码“和“微信收款码”替换为你自己的收款码。

3.8 其他功能

#showComments   // 在除博文之外的页面显示评论插件,比如在“关于”笔记中添加此标签,那么“关于”界面中就会出现评论系统,下同
#showReward     // 在除博文之外的页面显示赞赏按钮
#swapInfoCard   // 交换主页左右边栏(博主信息与说说)的位置。 已删除,不支持

3.9 友链功能的说明

3.9.1 更改自己的友链信息

将友链(位置:DIY导航栏 - 关于 - 友链)笔记中的属性修改为你自己的博客信息:

#shareAlias=friendCircle  #categoryName=朋友圈  #friendCircleUrl="你部署后的服务器地址"

3.9.2 添加别人为友链

同样在友链笔记中按照格式续上即可:

"<编号>": {
   "title": "<博客名称>",
   "link": "<博客链接>",
   "img": "<博主头像>",
   "des": "<博客简介>"
}

四、使用指南

4.1 使用个人动态(说说)功能

添加以下属性以开启个人动态(说说)功能,默认开启:

#enablePersonalDynamic  // 发动态时,只需要将博文的分类填写为「说说」即可。

4.2 使用推荐阅读功能

添加以下属性以开启推荐阅读功能,默认开启:

#enableRecommendedReading  // 使用时,只需要将博文放置于「推荐阅读」下方即可。

4.3 建立博客分类

建立博客分类很简单,直接在「文章分类」笔记下方建立子笔记,然后在该笔记上赋予以下属性:

#categoryName = xxx                // (必须)这个是用于「blogStateChange」脚本查找对应分类的名称,最好与分类标题保持一致
#shareAlias=category_xxx           // (必须)xxx 的值请与categoryName 中填写的值保持一致
#sorted=date #sortDirection=desc   // (非必须,但推荐)使博文按发表时间降序排列

4.4 使用标签功能

标签无需手动创建,在博文中的#标签中填写好标签,在博文发布时会自动创建标签。

4.5 发布博客的流程

你可以在笔记库的任何地方写博客,在这之前唯一需要做的就是,新建博文的时候请选择「博文模板」。

4.6 新建博文的流程

右键任何你想存放博文的父笔记(比如今日日记) 在弹出的窗口上将鼠标移动到【Insert child note】 选择【博文模板】 博文具有 5 个基本属性:

分类  // 该博文归属的分类,需要与上文中对应分类的#categoryName的值一致。
标签  // 该博文的标签,支持添加多个标签
头图  // 博文在首页显示的预览图,需要填写图片网络链接/图床链接
时间  // 博文的发表时间
作者  // 文章的作者

发布博客的方式很简单,点击【发布】按钮即可自动发布;如果需要下架某篇博文,只需要将【发布】取消勾选。

4.7 如何置顶博文

在想要置顶的博文中添加以下属性,该博文会在「时间线」以及对应的分类中置顶。

#blogPostTop

4.8 代码高亮

本主题自带 prismJS 代码高亮插件,目前支持 HTML、XML、SVG、MathML、SSML、Atom、RSS、CSS、JavaScript、EJS、Go、C、C++、Python、ini、Bash、Json、Shell、SQL、TypeScript、YAML。

五、注意事项

删除了导航中的分类、标签、归档、现在;不包含今日热榜等。

如果需要将文章页面宽度自适应,可调整以下这里的宽度。把 max-width 删除即可

image.png

六、相关文章

在折腾这个时汇总的文章

Trilium 安装部署 | shmaur

自建 RSS 并通过 docker 部署网站地图 | shmaur

Trilium 使用技巧合集 | shmaur

Trilium 集成强大免费的 drawio 画图 | shmaur

Trilium博客主题:Ankia 使用指南 - 东东的小黑盒

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 201,681评论 5 474
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 84,710评论 2 377
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 148,623评论 0 334
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,202评论 1 272
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,232评论 5 363
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,368评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,795评论 3 393
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,461评论 0 256
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,647评论 1 295
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,476评论 2 317
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,525评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,226评论 3 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,785评论 3 303
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,857评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,090评论 1 258
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 42,647评论 2 348
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,215评论 2 341

推荐阅读更多精彩内容