mirror/polybar
3
0
Fork 0
mirror of https://github.com/polybar/polybar.git synced 2025-12-01 12:07:57 +00:00
Code Issues Packages Projects Releases Wiki Activity
Page: Module: github
Pages
Compiling Configuration Debugging your Config Distro Specific Setup Fonts Formatting Home Inter process messaging Known Issues Module: alsa Module: backlight Module: battery Module: bspwm Module: cpu Module: date Module: filesystem Module: github Module: i3 Module: ipc Module: memory Module: menu Module: mpd Module: network Module: pulseaudio Module: script Module: temperature Module: text Module: xbacklight Module: xkeyboard Module: xwindow Module: xworkspaces Release Guidelines Style Guide Testing User contributed modules
Clone
Module: github
Judson Lester edited this page 2022-10-05 14:54:03 -07:00
Table of Contents

This module shows the unread notification count using the GitHub API.

NOTE: This module requires the project to be built with cURL support.

You will need to generate a GitHub personal access token where at least notifications is in the scope.

Basic settings

[module/github]
type = internal/github

; Accessing an access token stored in file
token = ${file:/path/to/file/containing/github/access.token}

; Accessing an access token stored in an environment variable
token = ${env:GITHUB_ACCESS_TOKEN}

; The github user for the token
; Effectively required; otherwise the module uses a deprecated method of fetching
; notifications, which has stopped working
user = github_user

; Whether empty notifications should be displayed or not
empty-notifications = false

; Number of seconds in between requests
interval = 10

; Github API URL
; Default: https://api.github.com/
api-url = https://hub.example.org/api/v3/

Additional formatting

; Available tags:
;   <label> (default)
format = <label>

; Available tokens:
;   %notifications% (default)
; Default: Notifications: %notifications%
label = %notifications%

; Used when GitHub can't be reached
; Available tags:
;   <label-offline> (default)
format-offline = <label-offline>

; Available tokens:
;   None
; Default: Offline
label-offline = Offline
This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.