https://github.com/paul-go/syndibutton
Subscribe to HTML Syndications from web browsers.
https://github.com/paul-go/syndibutton
javascript syndication typescript website
Last synced: 3 months ago
JSON representation
Subscribe to HTML Syndications from web browsers.
- Host: GitHub
- URL: https://github.com/paul-go/syndibutton
- Owner: paul-go
- Created: 2023-07-17T13:24:50.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2023-07-21T17:36:04.000Z (almost 2 years ago)
- Last Synced: 2025-01-12T11:33:27.400Z (4 months ago)
- Topics: javascript, syndication, typescript, website
- Language: TypeScript
- Homepage:
- Size: 15.6 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
# Syndi Button
This repository contains a library that renders *Subscribe* buttons on websites, allowing visitors to subscribe to feeds in the HTML Syndication format. The library displays a modal with a best-we-can-do UX, which asks the user if they have a compliant HTML Reader app installed, and gives them to the download page of a compliant app if they don't.
## Installation
Paste this script tag at the **bottom** of your HTML page:
```html
```
In order to create a button, create a hyperlink with the `data-subscribe` attribute populated the feed URLs as shown below:
```html
Subscribe!
```
You can subscribe to multiple feeds at once by specifying a space-separated list of feed URLs:
```html
Subscribe!
```
## Changing The Recommended Reader
In order for an end user to be able to subscribe to an HTML Syndication, they must have a compatible reader app installed on their device. You can configure what reader you recommend to your users by including a `` tag in the `` section of your HTML, as shown below.
The meta tag is a space-separated list of key=value pairs, where the key is a well-known string that specifies the platform, and the URL is a download URL where the reader app can be found.
If no such tag exists, this library defaults to using the download URLs for [Rail](https://github.com/paul-go/Rail).
```html
```
## Programmatic Usage
```typescript
// Pass one or more arguments to the SyndiButton.subscribe function
// in order to display the dialog:
SyndiButton.subscribe(
"http://a.com/path-to-feed/",
"http://b.com/path-to-feed/",
...
);
// Configure recommended readers:
SyndiButton.setRecommendedReaders({
ios: "https://itunes.apple.com/app/id1234",
android: "http://play.google.com/store/apps/details?id=com.app.name",
macos: "http://myapp.com/app.dmg",
windows: "http://myapp.com/app.msi",
linux: "http://myapp.com/app.tar.gz",
});
```