Plugin settings

The following describe the options available in plugin settings.

GitHub authentication

See Authentication.

Other settings

Default result size

Default: 10

The number of results to include on a table query. Can be overridden per-table using the per-page setting.

Status tooltips

Default: enabled

If enabled, adds a tooltip on hover of issue and pull request status icons that contains the status that icon represents.

Log level

Default: Error

Allows for more or less granular console logging from the plugin. There are the following options:

• Error - the least amount of logging, only errors are sent to the console.
• Warn - errors and warnings are sent to the console.
• Info - errors, warnings, and messages about normal plugin operation are sent to the console.
• Debug - your console will be flooded with messages showing the content of every request and response.

Cache settings

To prevent running up against the GitHub API rate limit and reduce network traffic, GitHub Link saves the content of request responses to plugin data. The exact details of how that cache is updated, how long each entry is valid for, and how much buffer time to add between requests is configurable with the following settings.

Cache save interval (seconds)

Default: 60 seconds

At this regular interval, the plugin will check to see if the cache needs to be updated on disk. If so, it writes the contents of the cache to plugin data. No I/O operations are performed if the value of the cache has not changed. Lowering the cache save interval means that the plugin will check for changes to the cache more often, while raising it means the cache will save more rarely.

Raising this value is only recommended if syncing your vault could incur a bandwidth charge, or you have an exceptionally large number of links cached.

Max cache age (hours)

Default: 120

When Obsidian starts and the plugin is loaded, cache entries older than this number of hours will be cleaned from disk. Note that even if a result is cached, the value will be updated if it has been more than the minimum time between the same request, so this value is only intended to keep the cache from growing too large.

Minimum time between same request (seconds)

Default: 60

The plugin will not call a GitHub API endpoint if that endpoint has already been called within this time frame with the same parameters.

Clear cache

This button will empty the request cache. If wanting to clean up old cache entries, it may be better to lower the max cache age.