Skip to content

Commit

Permalink
修改文档
Browse files Browse the repository at this point in the history
  • Loading branch information
sheldonxxd committed Apr 30, 2022
1 parent aa78c78 commit 9ef3cb3
Show file tree
Hide file tree
Showing 12 changed files with 202 additions and 77 deletions.
2 changes: 1 addition & 1 deletion .obsidian/app.json
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,6 @@
"newFileFolderPath": "01-Diary/本周事务",
"fileSortOrder": "alphabetical",
"legacyEditor": false,
"livePreview": false,
"livePreview": true,
"defaultViewMode": "source"
}
2 changes: 1 addition & 1 deletion .obsidian/plugins/obsidian-tabs/data.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"tabEnabled": true,
"rowOverflow": false,
"horizontalToVertical": false,
"horizontalToVertical": true,
"hideButtons": false,
"smallTitle": false,
"compactTitle": false,
Expand Down
52 changes: 48 additions & 4 deletions .obsidian/plugins/recent-files-obsidian/data.json
Original file line number Diff line number Diff line change
@@ -1,16 +1,60 @@
{
"recentFiles": [
{
"basename": "99-黑曜石玩家指南",
"path": "03-Projects/99-黑曜石玩家指南/99-黑曜石玩家指南.md"
},
{
"basename": "README",
"path": "README.md"
},
{
"basename": "Mdnotes Default Template",
"path": "08-Assets/Scripts/Mdnotes Default Template.md"
"basename": "在obsidian中写幻灯片",
"path": "03-Projects/99-黑曜石玩家指南/1-obsidian入门/在obsidian中写幻灯片.md"
},
{
"basename": "99-黑曜石玩家指南",
"path": "03-Projects/99-黑曜石玩家指南/99-黑曜石玩家指南.md"
"basename": "obsidian新建个人相片集",
"path": "03-Projects/99-黑曜石玩家指南/4-附录/obsidian新建个人相片集.md"
},
{
"basename": "obsidian主题界面布局说明",
"path": "03-Projects/99-黑曜石玩家指南/4-附录/obsidian主题界面布局说明.md"
},
{
"basename": "新建课题项目",
"path": "03-Projects/99-黑曜石玩家指南/3-obsidian做课题/新建课题项目.md"
},
{
"basename": "跟踪领域内大牛",
"path": "03-Projects/99-黑曜石玩家指南/2-obsidian读文献/跟踪领域内大牛.md"
},
{
"basename": "主题阅读与比较阅读",
"path": "03-Projects/99-黑曜石玩家指南/2-obsidian读文献/主题阅读与比较阅读.md"
},
{
"basename": "阶段性文献阅读小结",
"path": "03-Projects/99-黑曜石玩家指南/2-obsidian读文献/阶段性文献阅读小结.md"
},
{
"basename": "软件下载安装",
"path": "03-Projects/99-黑曜石玩家指南/1-obsidian入门/软件下载安装.md"
},
{
"basename": "决定写obsidan教程",
"path": "03-Projects/99-黑曜石玩家指南/0-序言/决定写obsidan教程.md"
},
{
"basename": "每周小结",
"path": "09-Templates/每周小结.md"
},
{
"basename": "obsidian快捷键",
"path": "03-Projects/99-黑曜石玩家指南/4-附录/obsidian快捷键.md"
},
{
"basename": "Mdnotes Default Template",
"path": "08-Assets/Scripts/Mdnotes Default Template.md"
},
{
"basename": "2022-04-02",
Expand Down

Large diffs are not rendered by default.

72 changes: 57 additions & 15 deletions .obsidian/workspace
Original file line number Diff line number Diff line change
Expand Up @@ -9,19 +9,61 @@
"state": {
"type": "markdown",
"state": {
"file": "README.md",
"mode": "source",
"source": true
"file": "03-Projects/99-黑曜石玩家指南/99-黑曜石玩家指南.md",
"mode": "preview",
"source": false
}
},
"pane-relief:history-v1": {
"pos": 0,
"stack": [
{
"leaf": "98cc5d49cdfc2a41",
"group": null,
"state": "{\"type\":\"markdown\",\"state\":{\"file\":\"03-Projects/99-黑曜石玩家指南/99-黑曜石玩家指南.md\",\"mode\":\"preview\",\"source\":false}}",
"eState": "{\"scroll\":0.5}"
},
{
"leaf": "98cc5d49cdfc2a41",
"group": null,
"state": "{\"type\":\"markdown\",\"state\":{\"file\":\"README.md\",\"mode\":\"source\",\"source\":false}}",
"eState": "{\"cursor\":{\"from\":{\"line\":128,\"ch\":0},\"to\":{\"line\":128,\"ch\":0}},\"scroll\":0}"
},
{
"leaf": "98cc5d49cdfc2a41",
"group": null,
"state": "{\"type\":\"markdown\",\"state\":{\"file\":\"03-Projects/99-黑曜石玩家指南/4-附录/obsidian快捷键.md\",\"mode\":\"source\",\"source\":false}}",
"eState": "{\"cursor\":{\"from\":{\"line\":26,\"ch\":19},\"to\":{\"line\":26,\"ch\":19}},\"scroll\":11.936701580549904}"
},
{
"leaf": "98cc5d49cdfc2a41",
"group": null,
"state": "{\"type\":\"markdown\",\"state\":{\"file\":\"README.md\",\"mode\":\"source\",\"source\":false}}",
"eState": "{\"scroll\":25.914583683013916}"
},
{
"leaf": "98cc5d49cdfc2a41",
"group": null,
"state": "{\"type\":\"markdown\",\"state\":{\"file\":\"09-Templates/每周小结.md\",\"mode\":\"source\",\"source\":true}}",
"eState": "{}"
},
{
"leaf": "98cc5d49cdfc2a41",
"group": null,
"state": "{\"type\":\"markdown\",\"state\":{\"file\":\"README.md\",\"mode\":\"source\",\"source\":true}}",
"eState": "{\"cursor\":{\"from\":{\"line\":31,\"ch\":2},\"to\":{\"line\":31,\"ch\":2}},\"scroll\":22.7906}"
"eState": "{\"cursor\":{\"from\":{\"line\":30,\"ch\":115},\"to\":{\"line\":30,\"ch\":115}},\"scroll\":22.7806}"
},
{
"leaf": "98cc5d49cdfc2a41",
"group": null,
"state": "{\"type\":\"markdown\",\"state\":{\"file\":\"09-Templates/每周小结.md\",\"mode\":\"source\",\"source\":true}}",
"eState": "{\"cursor\":{\"from\":{\"line\":26,\"ch\":0},\"to\":{\"line\":26,\"ch\":0}},\"scroll\":0}"
},
{
"leaf": "98cc5d49cdfc2a41",
"group": null,
"state": "{\"type\":\"markdown\",\"state\":{\"file\":\"README.md\",\"mode\":\"source\",\"source\":true}}",
"eState": "{\"scroll\":22.78062505722046}"
},
{
"leaf": "98cc5d49cdfc2a41",
Expand Down Expand Up @@ -160,7 +202,7 @@
"state": {
"type": "backlink",
"state": {
"file": "README.md",
"file": "03-Projects/99-黑曜石玩家指南/99-黑曜石玩家指南.md",
"collapseAll": false,
"extraContext": false,
"sortOrder": "alphabetical",
Expand Down Expand Up @@ -193,7 +235,7 @@
"state": {
"type": "outline",
"state": {
"file": "README.md"
"file": "03-Projects/99-黑曜石玩家指南/99-黑曜石玩家指南.md"
}
},
"pane-relief:history-v1": {
Expand All @@ -210,15 +252,15 @@
},
"active": "98cc5d49cdfc2a41",
"lastOpenFiles": [
"README.md",
"08-Assets/Scripts/Mdnotes Default Template.md",
"03-Projects/99-黑曜石玩家指南/99-黑曜石玩家指南.md",
"01-Diary/日志存档/2022-04-02.md",
"01-Diary/周小结/2022-04-02_周小结.md",
"01-Diary/本周事务/这是草稿.md",
"02-Reading/summary/2022-04-02_文献阅读小结.md",
"08-Assets/MindMap/MindMap-发.md",
"00-MOC/AuthorRanking.md",
"00-MOC/阅读清单.md"
"README.md",
"03-Projects/99-黑曜石玩家指南/1-obsidian入门/在obsidian中写幻灯片.md",
"03-Projects/99-黑曜石玩家指南/4-附录/obsidian新建个人相片集.md",
"03-Projects/99-黑曜石玩家指南/4-附录/obsidian主题界面布局说明.md",
"03-Projects/99-黑曜石玩家指南/3-obsidian做课题/新建课题项目.md",
"03-Projects/99-黑曜石玩家指南/2-obsidian读文献/跟踪领域内大牛.md",
"03-Projects/99-黑曜石玩家指南/2-obsidian读文献/主题阅读与比较阅读.md",
"03-Projects/99-黑曜石玩家指南/2-obsidian读文献/阶段性文献阅读小结.md",
"03-Projects/99-黑曜石玩家指南/1-obsidian入门/软件下载安装.md"
]
}
Original file line number Diff line number Diff line change
Expand Up @@ -68,6 +68,27 @@ title: 标题的作用

注意插入的图片`![[image.png]]`最好独占一行,而且前后均有空行。

#### 图片细节样式控制

本模板库使用的 [Blue Topaz 主题](https://github.com/cumany/Blue-topaz-examples)提供了丰富的对内容样式的调整方法。如果想控制图片的大小,可以是:

`![[img.png|300]]`

此时图片的宽度显示为 300 px。如果想插入 figure caption,建议如下操作:

`![[img.png#center|figure 1. 这是一张图表|500]]`

简单说明一下,图片文件名后面跟的 `#center` 指明了图片至于中间的位置,然后接下来 `|` 后面就是图注内容,再到后面则是指定显示宽度。

如果你想并排显示多张图片,可以像下面这样弄:

`![[img1.png|+grid]] ![[img2.png|+grid]]`

只要把图片后面跟一个 `+grid` 的说明即可。

```ad-warning
当你对图片的样式进行了调整之后,只能用 obsidian 自带的导出 pdf 才会维持这种样式。如果是通过自定义的方式 导出为 word 和 html,会出现报错。
```

### 插入表格

Expand All @@ -86,6 +107,8 @@ markdown 中输入表格一直都不大方便,不过在 obsidian 中情况还

事实上得益于插件,你还可以直接在 obsidian 中对表格进行计算,下载表格中的数据另存为 csv文件。但是这里限于篇幅不做过多讲述,感兴趣的朋友可自行查看插件列表。

于2022年4月30日新增了 excel-to-markdown-table 插件,用户可以直接从 excel 表格中复制,然后粘贴到 obsidian 中,直接转换为 markdown style 的表格。

### 插入其它附件

除了可以在草稿中插入图片,您还可以插入视频,音频等多媒体文件。您可以通过快捷键 `Ctrl+E` 进行「全局预览」并播放。当然也可以按住 Ctrl 键,将鼠标悬停于这些附件链接上方实现「局部预览」。
Expand Down Expand Up @@ -117,9 +140,6 @@ markdown 中输入表格一直都不大方便,不过在 obsidian 中情况还

![[Pasted image 20220331162910.png]]

```ad-tip
其实也可以使用split面板的方式,并将新面板设置为预览模式,这样实现编辑和预览的分离。这个是经典的 markdown 编辑器的做法。
```


### 多使用分节小标题
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ title: 友情提示

如上图所示,由于草稿创建后自动在 `01-Diary/本周事务` 目录下生成文件,然后草稿的很多 front-matter 可以作为元数据被 dataview插件 抓取。这里我通过一个 query 提取了草稿的文件名、标签、摘要和最后修改日期。在预览模式下,当鼠标悬停于文件名时,还能够激活局部预览。

这里涉及到使用 dataview 插件对相关内容进行整合和显示。由于 dataview 插件使用较为复杂,我不推荐大家入门阶段就去了解和掌握。有基础的童鞋可以直接跳转后边的内容👉[[Dataview - 数据查询增强]]
这里涉及到使用 dataview 插件对相关内容进行整合和显示。由于 dataview 插件使用较为复杂,我不推荐大家入门阶段就去了解和掌握。有基础的童鞋可以直接跳转后边的内容。

### 创建周小结

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,13 @@ obsidian 截至目前(2022年3月21日)仍然是开源免费的笔记软件

它可以在 Windows、Linux、macOS多种系统平台上使用。虽然它也有移动设备版本,但是考虑到个人知识库的 heavy 的特点,我仍然建议您以使用桌面客户端为主。**本教程以 Windows 11 操作系统为例展开**,其它操作系统大同小异。

```ad-warning
Mac操作系统容易遇见 python 环境配置问题。
```

另外 obsidian 也有一些付费功能,如果您有发布和云同步的需求,可以购买使用。

请您先不要理会网上一大堆关于「双链笔记」的说明,「双链」这个概念现在咱们还用不着理会
请您先不要理会网上一大堆关于「双链笔记」的说明,「双链」这个概念现在咱们还用不着

[obsidian 官网](https://obsidian.md/)下载了安装包之后,直接一路默认安装即可。由于真正占用存储空间的个人资料以及主题插件都保存在指定的目录下,所以您可以放心把它安装到 C 盘,而无需担心长时间使用之后 C 盘空间不足的情况。

Expand All @@ -48,14 +52,14 @@ title: 更新请注意

![[Pasted image 20220321142732.png]]

zotero 是老牌的文献信息管理软件,同样是开源免费,而且多平台可以使用的一个工具,它的功能与 endnote 和 mendeley 等软件类似,都可以在写论文时插入参考文献,但是更加强大。截至目前(2022年3月21日),zotero 版本号已经到 6.0,与之前最大的区别在于提供了内嵌的 pdf 阅读器。
zotero 是老牌的文献信息管理软件,同样是开源免费,而且多平台可以使用的一个工具,它的功能与 endnote 和 mendeley 等软件类似,都可以在写论文时插入参考文献,但是更加强大。截至2022年3月21日,zotero 版本号已经到 6.0,与之前最大的区别在于提供了内嵌的 pdf 阅读器。

在 zotero 官网下载软件包后同样默认安装即可,因为占大头的 pdf 附件我们后面会指定存储到 obsidian 的 vault 库中。

### zotero插件下载

- [Zotfile](https://github.com/jlegewie/zotfile/releases):自动 rename 附件,然后复制到制定目录,还能从 pdf 中提取高亮注释。请下载最新的 release 中提供的后缀为 `.xpi` 的文件。
- Mdnotes:将文献记录按照模板生成 markdown 笔记。目前原作者已停止开发支持,但「青柠学术」(微信公众号:qnscholar)提供了[兼容 zotero 6.0 版本的插件 in 百度网盘](https://pan.baidu.com/s/1NScxVBWfYGMJFL4kIwEddA),提取码为 eiy7(如失效请联系我获取)
- [Mdnotes](https://github.com/argenos/zotero-mdnotes/releases):将文献记录按照模板生成 markdown 笔记
- [Better Bibtex](https://github.com/retorquere/zotero-better-bibtex/releases/tag/v5.5.4):生成 citation key,导出为更好的 bibtex 记录,也可以是 json,配合 obsidian 的 citations 插件使用。请下载最新的 release 中提供的后缀为 `.xpi` 的文件。


Expand All @@ -71,7 +75,7 @@ pip install pyperclip bibtexparser
```

```ad-warning
anaconda 虽然包含了大量所需的模块,但本模板库内使用的代码还需 pyperclip 和 bibtexparser 以支持粘贴板交互和读写 bib 文件。
anaconda 虽然包含了大量所需的模块(如requests 和 pillow),但本模板库内使用的代码还需 pyperclip 和 bibtexparser 以支持粘贴板交互和读写 bib 文件。
```

### pandoc 安装与配置
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,6 +81,7 @@ title: 友情提示

```ad-warning
请务必关联创建 mdnotes 和锁定 citekey 这两个操作,这样文献条目📌的标记还有助于你判断 mdnotes 是否创建。如果已经创建 mdnotes,后面就不要再创建了,否则会覆盖已有的文献阅读笔记,那就惨了。
如果是批量连续生成 mdnotes 时遇到这种文件覆盖问题,可以将新生成的 mdnotes 文件名统一修改为 xxx.md,避免对已有文件的覆盖,同时不中断后面的 mdnotes 文件生成。
```


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,4 +25,5 @@ share: false
- `Ctrl+/`:注释掉选中的文字
- `Ctrl+Enter`:创建或完成TODO清单
- `Alt+T`:跳转到今日日志页面
- `Ctrl+0` :将编辑器的实时预览切换为纯文本编辑模式

10 changes: 8 additions & 2 deletions 09-Templates/每周小结.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,17 +7,23 @@ excerpt:
---

### 日志汇总
%%鼠标悬停于日志File上可激活Hover Editor,拖动自动固定,然后可以直接在预览窗口浏览日志内容并完善摘要%%

```dataview
TABLE excerpt AS Summary, rating AS Rating
FROM "01-Diary/日志存档" AND #dailynote
WHERE date(file.name)<date(<% tp.date.now("YYYY-MM-DD", 1) %>) AND date(file.name) >= date(<% tp.date.now("YYYY-MM-DD", -6) %>)
WHERE date(file.name)<date(<% tp.date.now("YYYY-MM-DD") %>) AND date(file.name) >= date(<% tp.date.now("YYYY-MM-DD", -7) %>)
SORT file.name asc
```

### 本周完成事项汇总
%%请从[[本周事务表]]中截取已完成部分之后,运行 `quickAdd: 📒草稿归档` 命令以自动归档%%
%%请完善下表中已完成页面的front-matter信息后,运行 `quickAdd: 📒草稿归档` 命令以自动归档%%

```dataview
TABLE excerpt AS Summary, rating AS Rating, destination AS Folder
WHERE file.mday > date(<% tp.date.now("YYYY-MM-DD", -7) %>) AND status = "complete"
SORT rating desc
```

### 本周小结
%%此处作为工作生活学习多方面的概括性描述。对于小组会报告的情况,您可以根据本周事务草稿内容,制作obsidian幻灯片,用于小组会公开展示%%
Expand Down
Loading

0 comments on commit 9ef3cb3

Please sign in to comment.