Obsidian 插件:Gist
插件名片
概述
这是一个用于显示 GitHub Gist 的插件。
原文出处
下面自述文件的来源于 Readme
Readme(翻译)
下面是 obsidian-gist 插件的自述翻译
Obsidian GitHub Gist 插件
这是一个在 Obsidian 中渲染 GitHub Gist 的插件。
示例
gist
标记的代码块将被渲染为嵌入的 Gist 视图。
- 只使用 Gist ID:
```gist
30efbfd874fb1a16176d3f638a1e712a
```
- 使用用户名和 Gist ID:
```gist
linjunpop/30efbfd874fb1a16176d3f638a1e712a
```
- 指定只显示 Gist 中的单个文件:
```gist
linjunpop/30efbfd874fb1a16176d3f638a1e712a#math.ex
30efbfd874fb1a16176d3f638a1e712a#concat.ex
```
安装
从 Obsidian 应用程序安装
在 设置 -> 社区插件 中搜索 “Gist”,您可以找到并安装此插件。
您可以查看官方指南 https://help.obsidian.md/Advanced+topics/Third-party+plugins#Discover+and+install+community+plugins。
手动安装插件
找到最新的发布版本:https://github.com/linjunpop/obsidian-gist/releases,然后将 main.js
、manifest.json
和 styles.css
复制到你的 vault 的 .obsidian/plugins/obsidian-gist
目录下(例如 VaultFolder/.obsidian/plugins/obsidian-gist/
)。
开发
在本地开发插件
- 将此存储库克隆到本地开发文件夹。为了方便起见,您可以将此文件夹放在您的
.obsidian/plugins/obsidian-gist
文件夹中。 - 安装 NodeJS,然后在存储库文件夹下的命令行中运行
npm i
。 - 运行
npm run dev
将main.ts
编译为main.js
。 - 对
main.ts
进行更改(或创建新的.ts
文件)。这些更改应自动编译到main.js
中。 - 重新加载 Obsidian 以加载插件的新版本。
- 在设置窗口中启用插件。
发布新版本
- 使用新的版本号(例如
1.0.1
)更新manifest.json
文件,并指定最新版本所需的最低 Obsidian 版本。 - 在
versions.json
文件中更新"new-plugin-version": "minimum-obsidian-version"
,以便旧版本的 Obsidian 可以下载与其兼容的旧版本插件。 - 使用新的版本号作为“标签版本”创建新的 GitHub 发布。请使用精确的版本号,不要包含前缀
v
。 - 将
manifest.json
、main.js
和styles.css
文件作为二进制附件上传。 - 发布该版本。
反馈交流
其他渠道
版权声明
版权声明:所有 PKMer 文章如果需要转载,请附上原文出处链接。