Obsidian 插件：【Readme】Gistr

概述

Integrate OpenGist and Github gist snippets in your notes.

Readme(翻译）

下面是 gistr 插件的自述翻译

Obsidian: Gistr

• About
• Usage
  • OpenGist
  • Github Gist
• Install
  • Manual
  • BRAT Plugin Manager
• Build
• OpenGist - How It Works
• Shoutouts

关于

Gistr 允许您嵌入从两个不同服务创建的 gists：

• OpenGist（自托管）
• Github Gist

要使用此插件，您必须：

• 下载并安装 Obsidian.md
• 利用 Github 存储 gists，或者;
• 配置一个新的或使用现有的 OpenGist 服务器

用法

要嵌入一个 OpenGist 或 Github Gist 片段，请添加一个新的代码块：

OpenGist

```gistr
https://gist.yourdomain.com/username/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
gist.yourdomain.com/username/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```

Github Gist

```gistr
https://gist.github.com/username/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
gist.github.com/username/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
```

此插件还可以获取包含多个笔记的 Gist，这些笔记在单个 Gist 集合中：

要定位 Gist 中的特定笔记，请在您的 Gist 网址末尾添加 #filename：

```gistr
https://gist.github.com/Aetherinox/xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx#file1
```

安装

以下说明解释了如何为 Obsidian 安装此插件。

手册

• 安装 Obsidian.md
• 转到此 Github 仓库的 Releases 选项卡，并下载相关文件：
  • main.js
  • manifest.json
  • styles.css
  • 所有版本还包括上述文件的 .zip 文件。
• 找到 Obsidian 插件文件夹 X:\.obsidian\plugins
• 在 Plugins 文件夹中创建一个名为 gistr 的新文件夹
• 在新文件夹中，粘贴从此 Github 仓库下载的文件。

📂 .obsidian
   📂 plugins
      📂 gistr
         📄 main.js
         📄 manifest.json
         📄 styles.css

• 启动 Obsidian 并点击设置齿轮图标 ⚙️
• 在左侧，选择 Community Plugins
• 找到 Gistr 并启用它。

BRAT 插件管理器

插件也可以使用 BRAT 插件安装。

• 使用 Obsidian 插件管理器安装 BRAT
• 在左侧的 Obsidian 设置中，选择BRAT。
• 在 BRAT 设置中，点击添加 Beta 插件按钮
• 在文本框中，提供此存储库的 URL
  • https://github.com/Aetherinox/obsidian-gistr
• 安装完 Gistr 后，在 Obsidian 设置中激活它。

构建

有关如何下载此插件的源文件并编译您自己版本的详细说明，请查看下面的 wiki 链接：

• 如何构建Gistr

OpenGist - 工作原理

以下解释了此插件和 OpenGist 背后的过程。

截至 v1.6.0，OpenGist 包括一个类似 Github 的功能。每次您将新的 gist 上传到您的 OpenGist 网站时，您可以通过访问关联的链接来正常查看该 gist：

https://gist.yourdomain.com/username/000abcdef1234567abcdef1234567abc

使用 OpenGist，您现在可以获取有关 gist 的 JSON 信息，并将您的 gist 包含在外部程序中，例如 Obsidian.md。

要手动查看每个 OpenGist 的 JSON、HTML、Javascript 和 CSS 源，只需在 URL 末尾添加 .json：

https://gist.yourdomain.com/username/000abcdef1234567abcdef1234567abc.json

您将看到定义与您创建的 gist 相关联的值的 JSON：

{
  "created_at": "2023-09-24T00:00:000",
  "description": "Opengist Demo Paste",
  "embed": {
    "css": "https://gist.domain.com/assets/embed-abcde123.css",
    "html": "<div class=\"opengist-embed\" id=\"000abcdef1234567abcdef1234567abc\">\n    <div class=\"html \">\n    \n        <div class=\"rounded-md border-1 border-gray-100 dark:border-gray-800 overflow-auto mb-4\">\n            <div class=\"border-b-1 border-gray-100 dark:border-gray-700 text-xs p-2 pl-4 bg-gray-50 dark:bg-gray-800 text-gray-400\">\n                \n                <span class=\"float-right\"> · <span class=\"text-gray-700 dark:text-gray-200 font-bold\"></span></span>\n            </div>\n            \n            \n            \n            <div class=\"code dark:bg-gray-900\">\n            \n            \n                <table class=\"chroma table-code w-full whitespace-pre\" data-filename-slug=\"demo\" data-filename=\"demo\" style=\"font-size: 0.8em; border-spacing: 0; border-collapse: collapse;\">\n                    <tbody>\n                        \n                        \n                        <tr><td id=\"file-demo-1\" class=\"select-none line-num px-4\">1</td><td class=\"line-code\">Opengist Demo Paste\n</td></tr>\n                    </tbody>\n                </table>\n            \n            </div>\n            \n\n        </div>\n    \n    </div>\n</div>\n",
    "js": "https://gist.domain.com/Username/000abcdef1234567abcdef1234567abc.js",
    "js_dark": "https://gist.domain.com/Username/000abcdef1234567abcdef1234567abc.js?dark"
  },
  "files": [
    {
      "filename": "demo",
      "size": 743,
      "human_size": "145 B",
      "content": "Opengist Demo Paste",
      "truncated": false,
      "type": "Text"
    }
  ],
  "id": "000abcdef1234567abcdef1234567abc",
  "owner": "Username",
  "title": "Opengist Demo Paste",
  "uuid": "000abcdef1234567abcdef1234567abc",
  "visibility": "unlisted"
}

致谢

• thomiceli 在 OpenGist 实现了 JSON 功能请求。
• linjunpop 开发了第一个 Obsidian Gist 插件。它是我使用的插件列表中的首选之一。