nathonius_obsidian-github-link/README.md
2024-02-25 19:09:17 -05:00

35 lines
1.2 KiB
Markdown

# GitHub Link
[![Wiki Badge](https://img.shields.io/badge/wiki-documentation-blue?logo=github)](https://github.com/nathonius/obsidian-github-link/wiki)
[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=nathonius_obsidian-github-link&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=nathonius_obsidian-github-link)
**Obsidian + GitHub ❤️**
Transform boring GitHub links in notes into tags with rich content from GitHub, and query issues and pull requests within your notes.
## Use
### Links
Github links are automatically transformed into tags. For example, pasting `https://github.com/nathonius/obsidian-github-link/issues/1` into a note will become:
![ExampleTag](doc/ExampleInlineTag.png)
### Table
You can also include a table with results from a search query using a `github-query` codeblock. For example:
````
```github-query
outputType: table
queryType: pull-request
query: "is:pr repo:nathonius/obsidian-github-link"
columns: [number, title, author, status]
```
````
This produces a table of results that refreshes upon opening the note.
![ExampleTable](doc/ExampleQueryResult.png)
See the [documentation](https://github.com/nathonius/obsidian-github-link/wiki) for more info.