Add to signaloid.io Button
Add to signaloid.io is a Markdown snippet you drop into a GitHub
repository's README.md. Anyone reading the README on GitHub sees a button
that, when clicked, opens the Signaloid Cloud Developer Platform with the
repository pre-filled, ready to connect in one click.
The snippet
Replace <your repository URL here> with the full URL of the repository the
button should connect, then paste the snippet into your README.md:
[<img src="https://assets.signaloid.io/add-to-signaloid-cloud-logo-dark-v6.svg#gh-dark-mode-only" alt="[Add to signaloid.io]" height="30"/>](https://signaloid.io/repositories?connect=<your repository URL here>#gh-dark-mode-only)
[<img src="https://assets.signaloid.io/add-to-signaloid-cloud-logo-light-v6.svg#gh-light-mode-only" alt="[Add to signaloid.io]" height="30"/>](https://signaloid.io/repositories?connect=<your repository URL here>#gh-light-mode-only)
The snippet uses two lines, one for each of GitHub's light and dark themes. The
#gh-dark-mode-only and #gh-light-mode-only URL fragments are a
GitHub-flavored Markdown feature. GitHub picks the matching line based on the
viewer's theme, so the button always renders against the right background.
What happens when someone clicks the button
Clicking the button sends the visitor to https://signaloid.io/repositories
with the repository URL passed in a connect query parameter. The
Repositories page reads the parameter on mount and starts the
repository connection
flow:
- If the visitor is logged in and already has that repository connected, the page surfaces the existing connection.
- Otherwise, the page runs validation and presents the connect-confirmation dialog, the same one the in-app GitHub search uses.
The button only handles repositories hosted on github.com. Non-GitHub URLs in
the connect parameter are ignored.
Example
Related pages
- Repository Connection for the validation checks the button triggers.
- Repository Runs for what a visitor can do once the repository is connected.
- The "signaloid.yaml" File for shipping a default core configuration alongside the button, so visitors get a working setup on the first run.