Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Documentation on Ignoring Canonical URLs #431

Merged
merged 1 commit into from Jul 13, 2020
Merged

Add Documentation on Ignoring Canonical URLs #431

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
7 changes: 7 additions & 0 deletions README.md
View file
Open in desktop
Expand Up @@ -174,6 +174,13 @@ The Whitelisted Generic Onebox has some caveats for its use, beyond simply white
2. The URL you're oneboxing cannot be a root url (e.g. `http://example.com` won't work, but `http://example.com/page` will)
3. If the oneboxed URL responds with oEmbed and has a `rich` type: the `html` content must contain an `<iframe>`. Responses without an iframe will not be oneboxed.

Ignoring Canonical URLs
-----------------------
Onebox prefers to use canonical URL's instead of the raw inputed URL when searching for Open Graph metadata.
If your URL's canonical URL does not have opengraph metadata, use the `og:ignore_canonical` property to have Onebox ignore the canonical URL:
```html
<meta property="og:ignore_canonical" content="true" />
```

Installing
----------
Expand Down