Github Star

Integrations

Other apps

Github Star

The GitHub Star integration adds a "Star" button to your page footer, allowing visitors to easily star your GitHub repository. This is a great way to encourage community support and increase your repository's visibility.

Configuration

To enable the GitHub Star integration, add the following configuration to your docs.json:

{
  "integrations": {
    ".apps": {
      "githubStar": {
        "title": "Star",
        "label": "Show your support! Star us on GitHub ⭐️",
        "href": "https://github.com/livesession/xyd",
        "dataIcon": "octicon-star",
        "dataSize": "large",
        "dataShowCount": true,
        "ariaLabel": "Star livesession/xyd on GitHub"
      }
    }
  }
}

Reference

title
stringRequired
The title of the Github button
label
string
The label of the Github Button
href
stringRequired
The href of the Github project
dataShowCount
boolean
The data-show-count of the Github project
dataIcon
string
The data-icon of the Github button
dataSize
string
The data-size of the Github button
ariaLabel
string
The aria-label of the Github button

Customization

You can customize the appearance and behavior of the GitHub Star button by modifying the configuration options. The button is rendered using the github-buttons package, which provides a consistent look and feel with GitHub's official star button.

Analyics

Event name	Custom properties	Description
`docs.github_star.hover`	`-`	When user hover a Github Star.
`docs.github_star.click`	`-`	When user clicks a Github Star.

Edit page

LaunchDarkly Supademo