search

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
accelerated-mobile-pages amp amp-jekyll blog-theme github-pages jekyll jekyll-theme jekyll-theme-amp jekyll-themes responsive-theme theme

readme

🎨 AMP Affiliately Jekyll Theme

This project offers an AMP-ready Jekyll theme for your blogs and websites.

Made with Jekyll GitHub last commit CodeQL Deploy Jekyll site to Pages Website Monitoring

👀 Live Demo

AMP Affiliately Jekyll Theme

🌐 Demo Site ↗

🌈 Features

✨ New Features in v2.x.x

What is AMP ⚡

AMP stands for Accelerated Mobile Pages ↗, a Google-backed project designed as an open standard for any publisher to have pages load quickly on mobile devices.

Installation 🧰

There are various ways to install the theme:

1. Cloning the repository and updating settings

  1. Fork this repository and clone the forked repository.
  2. Update the _config.yml file as per your requirements.
  3. Add your posts to the _posts directory.
  4. Deploy to your server or Github Pages (read Deploying to GitHub Pages with GitHub Actions ).

2. Set up as a remote theme and updating settings

Read the procedures in the Config Guide ↗.

Configurations 🛠️

Enabling Third-Party Components 🧩

Disqus Comments in AMP 💬

  1. Download this HTML file ↗ (last updated on 2024-01-13) and deploy it to another domain or subdomain.
  2. Copy the external URL link as the value of amp_disqus_url in _config.yml.
  3. Use amp_disqus_height to configure the height of <amp-iframe> if needed (default is 140).

Enabling Pagination for Blog Posts ⏪⏩

  1. Make a new folder named blog in your root directory.
  2. Create an empty HTML file in the new folder and name it index.html.

  3. Copy the following front matter to the HTML file:

    ---
layout: blog-pagination
---

Enabling Lists of Categories and Tags 📁🔖

  1. In your root directory, create a folder named category and tag, respectively.
  2. New a file and name it to index.html in your category and/or tag folder(s).

  3. Copy the following front matters to the corresponding index.html:

    • For category/index.html,

      ---
layout: category-list
title: List of Categories
---

    • For tag/index.html

      ---
layout: tag-list
title: List of Tags
---

Sidebar Widgets 🧙‍♂️

Writing Posts 📝

You can write posts just as you would in Jekyll, the only difference being that AMP has some strict guidelines on including external content.

You cannot use Markdown format or normal HTML tags. AMP provides its own custom tags for images, videos, etc. For examples,

🖼 Images

Use the picture.html template to insert an image in the AMP format for automatically serving the image in the WebP format. The template also wraps the image with a <figure> tag with an optional caption element.

{% include picture.html img="welcome.jpg" height="400" width="800" %}

OPTIONS ↗

DEMOS - Image in AMP ↗

📹 YouTube Videos

You need to include the following front-matter variable to enable YouTube embeds.

amp:
   youtube: true

To embed a single video, use the following tag to include the youtube.html template.

{% include youtube.html id="<YOUTUBE_VIDEO_UID>" title="Welcome to Watch this Video" %}

To embed a playlist, you need to set both the playlist ID and the ID of the first video within the playlist.

{% include youtube.html id="<YOUTUBE_VIDEO_UID>" \
   playlist="<YOUTUBE_PLAYLIST_UID>" title="Welcome to Watch this Video" %}

DEMOS - YouTube Embeds ↗

💻 Codes

This theme supports syntax highlighting based on Rouge, which is the default highlighter in Jekyll 3 and above. All CSS styles for syntax highlighting are located in the amp-syntax-highlight.css under the _includes/css/ directory.

By default, this theme excludes the CSS styles for syntax highlighting. The AMP framework limits the total CSS styles up to 75,000 bytes per AMP page. This keeps lightweight and rendering fast.

To include the stylesheet on-demand, you need to add the following to your post's front matter:

css:
  syntax: true

DEMOS - Code Block ↗

📌 Callout beta

A shortcode for creating a colored box, e.g. tips/memo.

{% capture label %}
   PUT YOUR MARKDOWN CONTENT HERE...
{% endcapture %}

{% include callout.html content=label %}

Front Matters

Using AMP Components ⚡

Some AMP components require you to specify external scripts before using them. You can specify these scripts in the head.html file in the includes directory after the already imported scripts and then use these components in any post.

See Full AMP Documentation ↗ to learn more.

Validating Your AMP Pages 🐞

AMP provides a built-in validator to validate your pages. You can access this validator by opening the Developer Console in your browser and appending #development=1 to the end of any URL of your site, e.g. http://localhost:4000/#development=1.

If you have errors on your page, AMP will list those for you in the console. If no errors are on your page, you'll get a message "AMP Validation Successful" on the DevTools console.

Using Gulp to Run and Optimize Jekyll Build 🥤

Run the following command to install Gulp, AMP Optimizer, and other node packages in the root directory of your project:

npm install

Build Jekyll locally and run the Gulp pipeline with the following command:

npm run build

Deploying to GitHub Pages with GitHub Actions 🚀

This theme includes Jekyll plugins that are not in the whitelist of Github Pages. Therefore, to deploy it to your Github Pages, you need to use a custom Github Actions workflow to publish your site. The Action workflow is configured in the /.github/workflows/jekyll-build.yml. The workflow is triggered on pushes to the master branch and leverages GitHub Actions to:

  1. Build the Jekyll Site: Installs Ruby and Jekyll to build the site.
  2. Optimize AMP and Minify HTML: Runs AMP Optimizer and HTML minifier with gulp.js.
  3. Deploy to GitHub Pages: Publishs the built site to GitHub Pages.

🤝 Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/chriskyfung/amp-affiliately-jekyll-theme/ ↗. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant ↗ code of conduct.

To submit a pull request -

  1. Fork/clone the repository.
  2. Develop.
  3. Create a new branch from the master branch.
  4. Open a pull request on Github describing what was fixed or added.

💗 Support Me

Would you like to buy me a coffee? I would really appreciate it if you could support me for the theme development.

Buy Me A Coffee

🙏 Acknowledgement

This project is developed based on the MIT-licensed Affiliates ↗ Jekyll theme designed by Sal, WowThemes.net ↗.

⚖️ License

This theme is available as open-source under the terms of the MIT License ↗ under the same upstream license.