Obsidian 插件:【Readme】GitHub Link

Obsidian 插件:【Readme】GitHub Link

插件名片

  • 插件名称:GitHub Link
  • 插件作者:Nathonius
  • 插件说明:Enrich your notes with issue and pull request content from GitHub.
  • 插件分类:[‘obsidian 插件 ’, ‘readme’]
  • 项目地址:点我访问
  • 国内下载地址:下载安装

概述

Enrich your notes with issue and pull request content from GitHub.

原文出处

下面自述文件的来源于 Readme


Readme(翻译)

下面是 github-link 插件的自述翻译

【机翻】

GitHub 链接

Obsidian + GitHub ❤️

将笔记中无聊的 GitHub 链接转换为带有丰富内容的标签,并在笔记中查询问题和拉取请求。

使用

链接

Github 链接会自动转换为标签。例如,将 https://github.com/nathonius/obsidian-github-link/issues/1 粘贴到一个笔记中会变成:

GitHub 链接--链接

表格

您还可以使用 github-query 代码块包含来自搜索查询的结果表格。例如:

```github-query
outputType: table
queryType: pull-request
query: "is:pr repo:nathonius/obsidian-github-link"
columns: [number, title, author, status]
```

这将生成一个在打开笔记时刷新的结果表格。

GitHub 链接--表格

代码块必须是有效的 YAML。目前支持以下选项:

选项描述
outputTypetable必需的。目前仅支持表格。
queryTypeissue, pull-request必需的。
columns请参阅下面的支持列列表。必需的。应该是一个值数组。
query有效的 GitHub 搜索查询。对于自定义查询是必需的,会覆盖其他参数。查看 GitHub 文档 获取更多信息。

其他参数将取决于查询的类型。如果提供了 query 参数,则将忽略其他参数。每个部分描述了特定查询配置文件的一组参数。

列出我的分配的问题

注意: 这需要一个有效的令牌。

选项描述
org用户或组织的名称。如果未提供,将使用令牌作为默认帐户。
filterassigned, created, mentioned, subscribed, repos, all要返回的问题类型。allrepos 返回所有问题,不考虑参与情况。
stateopen, closed, all
labels标签或问题标签数组。只有匹配的问题将被包括在内。
sortcreated, updated, comments
directiondesc, asc
sinceYYYY-MM-DDTHH:MM:SSZ最小更新日期,完整的 ISO 格式。
per_page整数。每页返回的项目数。
page整数。要使用的结果页。
选项描述
org用户或组织的名称。必需。
repo仓库名称。必需。
milestone问题里程碑,里程碑编号,*none
stateopenclosedall
assignee用户的名称,*none
creator用户的名称。
mentioned用户的名称。
labels标签或问题标签数组。只包括匹配的问题。
sortcreatedupdatedcomments
directiondescasc
sinceYYYY-MM-DDTHH:MM:SSZ最小更新日期,完整的 ISO 格式。
per_page整数。每页返回的项目数。
page整数。要使用的结果页。
选项描述
org用户或组织的名称。必需。
repo仓库名称。必需。
stateopen, closed, all
headuser:ref-nameorg:ref-name.过滤到具有分支名称的头用户或组织。
basebranch-name-base按基本分支名称过滤。
sortcreated, updated, popularity, long-running
directiondesc, asc
per_page整数。每页返回的项目数。
page整数。要使用的结果页。

|

支持的列

如果未在下面列出的任何列仍然可以在 API 响应中包含时使用。可以通过给定 json 对象表示字符串来使用嵌套值引用该值。例如,user.login 将从 API 查询响应中获取用户名的原始值。

列名类型描述
numberpull-requestPR 编号和指向 PR 的链接。
repopull-request指向存储库的链接。
authorpull-request创建 PR 的用户以及一个小头像。
statuspull-requestPR 的当前状态。
created, updated, closedpull-request创建、最后更新和关闭日期的格式化版本。

设置

对于公共存储库,不需要额外配置。对于私人存储库,您需要通过 GitHub 登录。

认证

⚠️ 警告: 令牌将以明文形式存储。请自行承担风险。

认证仅需要一个 GitHub 账户。在 GitHub Link 插件设置中,添加一个新账户。给账户取一个名称。

该插件支持自动认证流程,或者您可以 生成自己的令牌。要使用自动流程,请选择“生成令牌”。在弹出的模态框中,复制代码并打开认证链接。在粘贴认证链接后,您将被提示允许访问 GitHub Link 插件。一旦接受,您可以返回 Obsidian,令牌将自动保存。

插件兼容性

有其他插件提供一些类似的功能:

这些插件和 GitHub Link 可能不兼容,目前不应该同时使用。



反馈交流

其他渠道

版权声明