I AM LISTENING TO
|
WHAT I LIKE
  • English
  • German
BLOG FILTER

Home » Development » HTML5 » Make Syntax Highlighting work in AMP-WP using GeSHi

Again another Google AMP article, this time dealing with Syntax Highlighting. If you have a code centric website, this is important.

In one of my last articles I talked about a Generic Syntax Highlighter.   This time I want to show you, how to add Syntax Highlighting with GeSHi to a custom template in AMP-WP.

FIRST SOME RESOURCES

Please read up on documentation, as I am not diving into every detail.

  1. AMP-WP – github.com/Automattic/amp-wp / Documentation
    The WordPress AMP integration. We will be using a custom template for our AMP pages.
  2. Crayon Syntax Highlighter github.com/aramk/crayon-syntax-highlighter
    I am using this for Syntax Highlighting on none AMP pages. It adds specific language classes to the code / pre areas, that I am using to configure GeSHi.
  3. GeSHi – github.com/GeSHi/geshi-1.0
    The Syntax Highlighter
  4. phpQuery – github.com/punkave/phpQuery
    DOM Document transversal & modification simplified. You should be able to apply the things below with any other tool as well.
  5. My tweaks on GitHub

ADDING GESHI TO AMP-WP

  1. Upload GeSHi and phpQuery to your desired location on your webserver.
  2. Call the custom template for AMP-WP in your functions.php

    I have an example stored on GitHub
  3. Create a custom template in your themes folder.We could use the following filters, but its easier to use the custom template, due to the GeSHi style setup. The problem is, that the style action is called before the content action within the template. But I am planning to build a TWIG template for myself, as I am running Timber everywhere. That will detach logic and content completely, allowing to rethink some of these things and make styling a lot easier :) So watch out for my next article!

    Add this to the top of your custom template:

    I have an example stored on GitHub. The above works, if you are using Crayon Syntax Highlighter for standard pages.
    If you use something else, this needs to be changed.
  4. Add the GeSHi styles to the amp-custom style tag


    I have an example stored on GitHub.
  5. Output updated amp-wp-content


    I have an example stored on GitHub.
  6. Save and check that your AMP page validates, by adding #development=1 to the end of the url. Check the console for errors.
    Show this page as AMP

Enjoy coding …

readmore

Due to Google AMP (Accelerated Mobile Pages) , I have been looking for a way to effectively do Syntax Highlighting without Javascript in pure PHP.

I was about to write my own, when I found an older article from phoboslab. Thanks Dominic for saving me some time ;) Its not perfect, but close enough.

A simple Syntax Highlighting Class that does just that. The class was not working with PHP 5.4.x+, as it uses  preg_replace() with the /e modifier.

It will not cover all, but its better than nothing :) I will also add a section to my my AMP tweaks article to showcase the integration of Geshi.

Here an updated version using the preg_replace_callback() function.

THE SYNTAX HIGHLIGHT CLASS

THE CSS

USAGE

@GitHub portalzine/UtilityBelt/SyntaxHighlight

Enjoy coding …

readmore
29. February 2016

AMP-WP Tweaks & Tips

The AMP (Accelerated Mobile Pages Project) plugin for WordPress is still pretty young and under heavy development.

There are little things that can help to fix current validation problems. I have a couple of fresh AMP pages, that are already indexed by Google.

0. RESOURCES


1. MISSING IMAGE (schema.org-NewsArticle)

The currently registered Microformats template (schema.org-NewsArticle) requires an image.
The AMP-WP documentation explains how to add a featured image to your pages (documentation).

I extended that a bit,  to link a default attachment image, I uploaded before. This needs to be added to your themes functions.php.

Next we adjust the Microformats definition. This needs to be added to your themes functions.php.


2. ADD YOUR OWN AMP TEMPLATE

Read the AMP-WP documentation first :) This forces AMP-WP to override the core template with your own. Use the default template as a reference.


3. REMOVE NONE VALIDATING CONTENT

Normally the core sanitizer should take care of that.  I am sure a filter will be added in the future. For now, this is a quick workaround. You can use a RegExp or DOMDocument to alter the amp-content in your custom template and filter things that break validation.

I am using phpQuery for now, as it allows me to add quick fixes. DOMNode or QueryPath works nicely as well :) Will be looking at the core sanitizer and options later this week. All of this is currently added to the custom template.

  1. Remove REL attributes that are not allowed. Only registered Microformat rel attributes are allowed.
  2. Remove attribute ALIGN
  3. Fix TARGET Attribute

Finally output the fixed content as HTML.

The above examples need to be tweaked to your specific content requirements.

The custom template “post_amp_content” before:

The custom template “post_amp_content” after:


4. ADD PREVIOUS & NEXT POST NAVIGATION

From the AMP specification :”Note, that AMP document may also be linked to directly…”

This is being added to the custom template as well.

Next:

Previous:


5. SYNTAX HIGHLIGHTING

You can find a simple pure PHP highlighter here. Not perfect, but a start. Don not forget to include the CSS :)

 

I will extend on this as new validation errors or tweaks come up. The core sanitizer of AMP-WP still needs some work and should allow us to do some of the above directly, when the content is parsed / converted for AMP.


 

 6. OTHER AMP ARTICLES

Make Syntax Highlighting work in AMP-WP using GeSHi

Time to get AMP ready

 

Enjoy coding …

 

readmore
26. February 2016

Time to get AMP ready

Google’s AMP is here to save us from slow mobile content delivery, by enforcing strict standards and limiting what is allowed within AMP pages. The pages only allow a subset of tags and introduce their own tags for fast prefetching of content (images, videos … AMP Specs)

THIS IS AMP

“The Accelerated Mobile Pages (“AMP”) Project is an open source initiative that came out of discussions between publishers and technology companies about the need to improve the entire mobile content ecosystem for everyone – publishers, consumer platforms, creators, and users.

Today, the expectation is that content should load super fast and be easy to explore. The reality is that content can take several seconds to load, or, because the user abandons the slow page, never fully loads at all. Accelerated Mobile Pages are web pages designed to load instantaneously – they are a step towards a better mobile web for all.”

AMP CACHE & VALIDATION

AMP pages are cached within the AMP Cache, providing even faster delivery of your content. The core libs validate your implementation and highlight any problems by pushing errors to the console.

INTEGRATION

The documentation lists all components currently supported within a page and experimental components in development as well.

  1. Introduction to AMP
  2. Video Introduction
  3. AMP for WordPress
  4. AMP Docs
  5. Q&A Video

I have already added AMP support to our blog posts:

  1. Standard page
  2. AMP page

Google’s Webmaster Tools also integrates a new section for AMP, to see how they perform.

WHAT AMP IS NOT

AMP is not supposed to replace your webpage, but offer a faster access point to presented content. It will not solve all use cases, but offer better performance for your simple reading pleasure for now. Its a start and lets see how it evolves ;)

Enjoy coding …

readmore

TimeCircles is a countdown / timer plugin. The plugin provides a huge amount of options to optimize the look to your  individual needs.

TimeCircles

readmore

gridstack.js is a jQuery plugin for widget layouts. It allows you to build draggable responsive bootstrap v3 friendly layouts. ”

Demo @ Github

readmore
13. February 2016

Markdown editors

As I mentioned the usage of Markdown for the Slate documentation builder, here some Markdown editors:

ULYSSES FOR MAC/ IPAD

Highly customizable editor.

http://www.ulyssesapp.com/

STACKEDIT INBROWSER SOLUTION

Use it anywhere and sync to dropbox if you like.

https://stackedit.io/

MARKDOWN PAD FOR WINDOWS

Nice split-screen setup, that shows you how the html conversion looks like.

http://markdownpad.com/

MARKMYWORDS FOR LINUX

A nice minimal editor that was developed for Elementary OS.

https://github.com/voldyman/MarkMyWords

Enjoy coding …

readmore

Alertify.js is a small library which provides light-weight, high performance browser dialogs.

Alertify @Github

readmore

jQuery.sheet is spreadsheet plugin, that offers creation, viewing and editing. All combined with a nice API.

jQuery.sheet

readmore
1. February 2016

Parse Alternatives

Now that Parse is phasing out (01/2017), people are looking for alternatives that offer:

  • Data Storage
  • Push Notifications
  • Usage Analytics
  • Dashboard
  • Social Integration
  • User Administration
  • Cloud Code Integration
  • Multiple Mobile Platform SDKs
  • Background Jobs
  • Crash Report

Collaborative list of Parse alternative backend service providers @ GitHub

readmore