tags | cssclass | source | obsidianUIMode | progress | title | updated | created |
---|---|---|---|---|---|---|---|
preview |
正在进行 |
README |
2023-01-07 15:01 |
2022-09-01 09:56 |
感谢@代码7 的视频
Compatible with Obsidian 1.0 !!
💡 引言
This Vault contains the basic functions of Obsidian and has built-in common Obsidian plugins. Notice:You need to open this vault with Obsidian
https://github.com/cumany/Blue-topaz-examples/releases/tag/20220816-lite
Recommend downloading the Lite version of the example vault to delete a large number of unnecessary plug-ins, download link注意:本示例库包含大量插件目前有七十多个,很多插件都是辅助类插件,可以根据需要删除或者关闭,为了方便初学者,特推出一个简化版示例库删减了大量不必要的插件下载链接 Release 20221208 lite 精简版 · cumany/Blue-topaz-examples (github.com)
本 Examples库 由 Cuman 建立,Tips 教程由 BT主题 作者 3F 撰写。 本库是一个包含 Obsidian 基本功能的入门库,并内置了 Obsidian 的常用插件。 需要用 Obsidian 软件打开本库即可。 特别感谢@Johnny @Lillianwho @lavi @成雙酱 @锋华 提供的教程和创作思路。 如果有问题或者建议 请加入 Topaz 社区 Topaz QQ群 Obsidian频道
🎞 视频教程
https://space.bilibili.com/1970226/channel/series
👉 后续更新 请关注
另外推荐鸟姐的 Homepage 也是很棒的风格 Rainbell129/Obsidian-Homepage: A dashboard for your obsidian vault. (github.com)
🚩 更新日志
[[Changlog]] Changlog.md (github.com)
效果图
内置的插件
斜体插件为可选插件,基本是辅助类,不影响功能性使用。 除去辅助类插件,剩余基本十几个插件就满足 Ob 个性化使用的同时还能体验不同的功能。
插件名称 | 解释 |
---|---|
ZH 增强编辑 | 提供大量格式排版相关快捷操作 |
workspaces-plus | 工作区切换 |
templater-obsidian | Ob 模板插件 |
tag-wrangler | (可选) 标签修改 |
Advanced Tables | (可选) 表格辅助 |
remember-cursor-position | (可选) 记住光标位置 |
recent-files-obsidian | (可选) 最近文件列表 |
quickadd | 快速添加命令和动作 |
plugin-changelogs | (可选) 插件历史记录 |
obsidian-theme-design-utilities | (可选) 主题调试插件 |
obsidian-style-settings | 主题设置插件,必备 |
obsidian-shellcommands | (可选) 系统命令执行插件 |
obsidian-outliner | 类似幕布大纲操作插件 |
obsidian-kanban | 看板 |
obsidian-frontmatter-tag-suggest | (可选)yaml 输入标签弹出提示 |
obsidian-collapse-all-plugin | (可选) 一键折叠文件夹 |
v0.13.14 之前的所见即所得插件, v0.13.14 之后的 ob 版本直接关闭即可 | |
obsidian-checklist-plugin | 任务列表插件 |
obsidian-banners | 主页显示头图 |
obsidian-admonition | 文本框插件 |
hotkey-helper | (可选) 热键提示插件 |
打开 ob 显示主页插件,非必须已禁用 | |
dataview | 数据查询插件 |
cMenu 魔改版 by cuman | (可选) 快捷工具栏,需要依赖 zh 增强编辑插件 |
语法高亮插件,不兼容 v0.13.14 之后的 ob 版本直接关闭即可 | |
calendar | 日历插件 |
buttons | 按钮插件 |
Obsidian Icon Folder | (可选) 文件自定义图标插件 |
obsidian-view-mode-by-frontmatter | 通过 yaml 设置文档默认打开是预览还是编辑模式 |
obsidian-floating-toc-plugin | (可选) 编辑模式浮动大纲 |
obsidian-memos by bon | 流水账的方式记录日记,依赖日记插件。 |
bartender | (可选) 隐藏边栏图标和状态栏图标 |
sortable | (可选) 表格列排序插件 |
markdown Pretiffier | (可选)md 格式辅助插件可以自动生成更新日期 |
Search on Internet | (可选)ob 中快捷进行网络搜索 |
booknote | (可选)pdf 查看和标注插件 |
cm-chs-patch | (可选)中文分词插件 |
obsidian-core-search-assistant-plugin | (可选)增强搜索插件,搜索结果卡片显示 |
various-complements | (可选)自动补全插件 |
obsidian-linter | (可选)自动更新 yaml 日期插件 |
table-editor-obsidian | (可选)表格悬浮编辑插件 |
obsidian-regex-replace | (可选)支持正则表达式的查找替换插件 |
obsidian-version-history-diff | (可选)文档修改历史恢复插件 (ctrl+r) |
waypoint | (可选)文件夹 moc 生成插件 |
obsidian-dynamic-highlights | (可选)实时预览模式下,按高亮指定文档比如日记中的时间 |
obsidian-hover-editor | 悬浮插件,让窗口直接悬浮 |
Obsidian-Agtable | (可选)普通表格转为可视化编辑表格 |
主题内置的 cssclass 样式表
path: 77-Example usage:
^|文件名称|cssclass|用法|
^|---|---| ---|
|[[$filename]]|$frontmatter:cssclass|$frontmatter:usage|
文件名称 | cssclass | 用法 |
---|---|---|
[[电影观看清单-状态控制(dvjs)]] | cards | 对dataview表格渲染成卡片视图 |
[[电影观看清单(dv)]] | cards | 对dataview表格渲染成卡片视图 |
[[多彩高亮(三种语法)]] | colorful-highlight | 实时预览模式下正确显示多彩高亮 |
[[各类列表和彩虹大纲线]] | noscroll | 隐藏当前页面滚动条 |
[[卡片视图 展示笔记]] | zettelkasten | 把dv表格渲染成卡片样式 |
[[全宽显示-表格测试]] | fullwidth | 缩减栏宽开启下,控制页面全宽显示 |
[[首行缩进--以2022政府工作报告为例]] | indent | 实现单篇笔记首行缩进效果 |
[[四象限表格]] | matrix | 四象限表格样式 |
[[图书阅读清单-状态控制(dvjs)]] | cards | 对dataview表格渲染成卡片视图 |
[[图书阅读清单(dv)]] | cards | 对dataview表格渲染成卡片视图 |
[[涂黑和挖空效果(三种语法)]] | cloze | 实时预览模式下正确显示涂黑和挖空效果 |
[[伪看板-yaml声明]] | kanban | 伪看板的样式,无序列表四分栏 |
[[无序列表分栏]] | gridlist | 无序列表分两栏排布,可以配合伪看板(kanban)一起使用 |
[[预览隐藏frontmatter]] | noyaml | 预览状态不显示frontmatter区域 |
[[Callout环绕布局、缩进效果示例]] | fullwidth | callout实现文章环绕,全文缩进效果 |
[[code-wrap【代码块自动换行】]] | code-wrap | 代码块自动换行 |
[[example database]] | ||
[[Image-grid【图片自适应】]] | img-grid | 图片自适应分布 |
[[inline-list【行内列表】]] | inline-list | 图片和列表混排 |
<--> |
主题内置的 ad 样式表
ad 样式使用方法参考 [[分栏效果示例#前置条件]] [[分栏效果示例#AD样式效果]]
Admonition 类型 | 解释 | 使用 |
---|---|---|
blank | 全透明框 | ad-blank |
def | definition 定义 | ad-def |
thm | theorem 定理 | ad-thm |
lem | lemma 引理 | ad-lem |
cor | corollary 推论 | ad-cor |
pro | proposition 命题 | ad-pro |
hibox | 自动隐藏框 | ad-hibox |
col2 | 内容分左右两栏 | ad-col2 |
kanban | 伪看板 无序列表并列 | ad-kanban |
flex | 自适应元素分栏 | ad-flex |
Javascript 作用
88-Template\script
名称 | 功能 | 调用 js 的功能 |
---|---|---|
bookfromdouban.js | 根据 url 从豆瓣获取图书数据 | Quickadd- 宏 - 豆瓣读书 |
changeSticky.js | 快捷修改 home.md 中的四个便签内容 | Quickadd- 宏 - 添加首页便签 |
colorclock.js | 彩色时钟 js | 已通过 react 组件实现,此 js 已弃用 |
fetchhomepage.js | 获取主页中的联网数据 (OB 启动后加载) | quickadd- 宏 -Home 工作区 |
movies.js | 从 IMDB 获取电影数据 | quickadd- 宏 - 电影卡片 |
notice.js | 生成自定义边栏提示 | quickadd- 宏 - 生成 notice |
refreshhomepage.js | 重载主页数据,重新获取联网数据 | quickadd- 宏 - 重新获取主页数据 |
getrandomImage.js | 随机获取 99-Attachment\banner 文件夹的图片 | tp- 日记模板获取 banner |
getweather.js | 获取天气数据 | tp- 日记模板获取天气 |
❓ 常见问题
- 如何获取指定地区的天气?
- 侧边栏天气默认根据 ip 地址自动获取,修改 [[常用工具]] 并手动指定
https://i.tianqi.com/?c=code&id=34&bdc=%23&icon=4&site=14&py=chongqing
chongqing 改为你想要的城市拼音即可。 - 主页天气 也可以手动指定地区,quickadd 宏 -home 工作区 -- 点击 config-fetchhomepage 点击齿轮图标 即可设置天气. - 如何更换字体? 示例库默认配置的主字体为 [[LXGWWenKai-Light.ttf]] 代码块字体为 [[JetBrainsMono-Regular.ttf]] 可以自行安装,即可自动识别。 如果要安装其他字体,打开 style settings 设置,2.2.1 字体设置,主字体里填写 字体名称 即可。注意如果字体名称有空格需要用单引号括起来。 字体需要安装到系统里才会成功调用,比如 win 系统安装后显示的 字体名称 才是真正的字体名称。 ![[Pasted image 20220119151051.png]] ^d0e999
- 如何更换 Ob 背景图? 打开 style settings 设置,1.2.1 工作页面背景,开启背景,并在 custom theme light(亮色主题使用) 或者 custom theme dark(暗色主题使用) 里设置壁纸路径.壁纸路径需要使用类似格式 url("app://local/XXXXX) 设置本地图片。 比如 windows 图片路径置 url(app://local/D:/Documents/XXXX.jpg") mac 系统图片路径设置 url("app://local/Users/XXXX .jpg")
- 工作区页面背景跟笔记背景的区别? 工作区页面背景是指整个 OB 界面背景,笔记背景仅仅是当前 md 文档的背景。两者不冲突可以同时设置,当然这样背景也就叠加一起了。如果只需要整个 OB 是一个背景图,笔记背景关闭即可。
- 主页的歌曲和每日一言如何更新? 点击主页的 topaz 图片 或者侧边栏的重载主页 都可以重新获取最新的歌曲和一言。重新获取后如何没有显示出来,点击刷新主页即可。 ![[Pasted image 20220119152758.png]]
- 备忘录 Memos 无法启动打开? 开启核心插件日记,并指定日记文件夹位置。
- 主页加载部分数据没有显示全? 如果时钟不动或者主页没有显示全。手动点一下刷新主页即可。
- 带按钮的常用工具侧边栏如何实现?
其实就是
88-template/常用工具
笔记文档,打开后拖动文档标题前的图标到侧边栏即可。 - 示例库目前有五十多个插件,实在太多了,想保持示例库主要功能的话需要几个插件 示例库真正需要的核心插件并不多,大部分都是为了 Ob 使用更方便的辅助类插件,可以根据自己需要开启。 如果想体验最精简版本的示例库很简单。 按图修改 [[FastStart-StartupScript]] ![[Pasted image 20220315145116.png|500]] 即可启动最低示例库运行插件配置。 启动后启动 ob 只需要 100ms ![[Pasted image 20220315144725.png|300]]
- 侧边栏悬浮 memos 无法打开有错误提示?
需要先
ctrl+p
==>打开其他库
,然后选择示例库“20-diary”文件夹,打开一次之后,这个悬浮按钮就自动生效。详情看 [[Obsidian 库中库玩法#实现]] - 为什么在 style setting 下切换配色没什么效果? ![[Pasted image 20220429154332.png]] 注意 2.1 里面的颜色设置 是不是有自定义颜色。这里的自定义颜色设置优先级比较高,建议把里面的颜色设置都恢复成默认就可以了。
- 如何取消开启 ob 自动加载主页,我想打开 ob 出现上次关闭时的笔记? 打开 quickadd 设置,宏管理 关闭 home 工作区的 启动加载选项。 ![[Pasted image 20220523110336.png]]
- 如何移植动画版天气到自己的主页?并获取指定城市天气? 直接复制 " 文字版天气加图标 " 注释之间的内容,并 copy"88-Template/script/dv_weatherSvg.js" 启用【天气】weather.css 样式片段就移植成功了。设置指定地区天气,需要在 quickadd 宏 home 工作区中如图设置即可。![[Pasted image 20220531101243.png|400]]
- 如何移植动画猫到自己的主页中?
跟多彩时钟一样,动画猫也是 react 组件生成的。需要首先安装 react_component 插件,并 copy
\88-Template\ReactJS\react_cat.md
这样动画猫代码就生效了。
捐赠
如果你觉得不错,这个示例库对你使用 ob 有帮助,可以支持我一下。