javascriptbloggershared-hostingprettify

How can I use Prettify with Blogger/BlogSpot?


I'm using blogger.com to host some texts on programming, and I'd like to use Prettify (same as Stack Overflow) to nicely colour the code samples.

How do I install the Prettify scripts into the blog domain? Would it be better (if indeed it's possible) to link to a shared copy somewhere? I have webspace on a different domain. Would that help?


Solution

  • When you make a new entry in Blogger, you get the option to use HTML in your entry and to edit your blog entries.

    So type http://blogger.com, log in, and navigate to PostingEdit PostsEdit. In there put this at the top:

    <script type="text/javascript" language="javascript" src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.js"></script>
    <script type="text/javascript" language="javascript" src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/lang-css.min.js"></script>
    <script type="text/javascript">
    function addLoadEvent(func) {
      var oldonload = window.onload;
      if (typeof window.onload != 'function') {
        window.onload = func;
      } else {
        window.onload = function() {
          if (oldonload) {
            oldonload();
          }
          func();
        }
      }
    }
    addLoadEvent(function() {
        prettyPrint();
    });
    </script>
    <style type="text/css">
    /* Pretty printing styles. Used with prettify.js. */
    
    .str { color: #080; }
    .kwd { color: #008; }
    .com { color: #800; }
    .typ { color: #606; }
    .lit { color: #066; }
    .pun { color: #660; }
    .pln { color: #000; }
    .tag { color: #008; }
    .atn { color: #606; }
    .atv { color: #080; }
    .dec { color: #606; }
    pre.prettyprint { padding: 2px; border: 1px solid #888; }
    
    @media print {
      .str { color: #060; }
      .kwd { color: #006; font-weight: bold; }
      .com { color: #600; font-style: italic; }
      .typ { color: #404; font-weight: bold; }
      .lit { color: #044; }
      .pun { color: #440; }
      .pln { color: #000; }
      .tag { color: #006; font-weight: bold; }
      .atn { color: #404; }
      .atv { color: #060; }
    }
    </style>
    

    Note that you shouldn't use prettyPrint directly as an event handler. It confuses it (see the readme for details). Which is why we're passing addLoadEvent a function that then turns around and calls prettyPrint.

    In this case, because Blogger does not allow us to link to the stylesheet, we just embed the prettify.css contents.

    Then add a <code></code> tag or a <pre></pre> tag with the class name of "prettyprint". You can even specify the language like "prettyprint lang-html".

    So it can look like this:

    <pre class="prettyprint lang-html">
    <!-- your code here-->
    </pre>
    

    Or like this:

    <code class="prettyprint lang-html">
    <!-- your code here-->
    </code>
    

    The code that you put in needs to have its HTML cleaned from < and >. To do this, just paste your code in here: https://www.freeformatter.com/html-escape.html

    You can put the top code in your HTML layout, so that it’s included for all pages by default if you like.

    As of 2012, you can link CSS files in Blogger, so adding this to the <head> should be enough:

    <link href="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.css" rel="stylesheet" type="text/css" />
    <script type="text/javascript" language="javascript" src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/prettify.min.js"></script>
    <script type="text/javascript" language="javascript" src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/lang-css.min.js"></script>
    <script type="text/javascript">
        document.addEventListener('DOMContentLoaded',function() {
            prettyPrint();
        });
    </script>
    

    I chose not to replace the body onload event on purpose. Instead, I'm using the new DOMContentLoaded event that the old browsers don't support. If you need old browser support, you can use any other load event to initiate prettyPrint, for example jQuery:

    jQuery(function($){
        prettyPrint();
    });
    

    Or the supposedly smallest domready ever

    And you're done :)

    As Lim H pointed out in the comments, in case where you use the Blogger dynamic views (Ajax templates) then you need to use the method described here to bind custom JavaScript code: prettyPrint() doesn't get called on page load

    Use the guide at GitHub: https://github.com/google/code-prettify

    Basically just use this :)

    <script src="https://cdnjs.cloudflare.com/ajax/libs/prettify/r298/run_prettify.min.js"></script>
    <pre class="prettyprint"><code class="language-css">...</code></pre>