chriskyfung / amp-affiliately-jekyll-theme

An AMP-Ready Jekyll Blog Theme
https://chriskyfung.github.io/amp-affiliately-jekyll-theme/
MIT License
19 stars 12 forks source link

📝 docs (plugin.md): remove jekyll-gist from whitelist package list #48

Closed chriskyfung closed 9 months ago

chriskyfung commented 9 months ago

Problem

The theme's documentation website lists the jekyll-gist package as one of the whitelisted packages that can be used with the theme. However, this package is incompatible with AMP, and it renders script tags that break AMP validation and page layout.

Solution

The documentation website should remove the jekyll-gist package from the whitelist package list, and warn users not to use this package with the AMP-really theme. Instead, the documentation website should recommend alternative methods to embed GitHub gists in posts and pages, such as using the <amp-gist> component.

Steps to implement the solution