style: add & run prettier

.github/FUNDING.yml

@@ -1,2 +1,2 @@
-custom: ['https://www.paypal.me/janraasch/29,00']
+custom: ["https://www.paypal.me/janraasch/29,00"]
-github: ['janraasch']
+github: ["janraasch"]

.gitignore

@@ -1,2 +1,3 @@
 public
 exampleSite/public
+node_modules

.prettierignore

@@ -0,0 +1,6 @@
+build
+resources
+public
+static/font-awesome
+static/css/normalize.css
+layouts/index.html

.prettierrc.json

@@ -0,0 +1,10 @@
+{
+  "overrides": [
+    {
+      "files": ["*.html"],
+      "options": {
+        "parser": "go-template"
+      }
+    }
+  ]
+}

README.md

@@ -54,29 +54,30 @@ hugo new my-new-page.md
 
 ### Adding your branding / colors / css
 
-Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you may add a `<style>`-tag *or* you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Checkout the [`custom_head.html`](https://github.com/janraasch/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html)-file from the `exampleSite`-directory to get started and to find more detailed instructions.
+Add a `custom_head.html`-file to your `layouts/partials`-directory. In there you may add a `<style>`-tag _or_ you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Checkout the [`custom_head.html`](https://github.com/janraasch/hugo-scroll/blob/master/exampleSite/layouts/partials/custom_head.html)-file from the `exampleSite`-directory to get started and to find more detailed instructions.
 
 ## Issues / Feedback / Contributing
+
 Please use [GitHub issues](https://github.com/janraasch/hugo-scroll/issues) and [Pull Requests](https://github.com/janraasch/hugo-scroll/pulls).
 
 If you do not have a GitHub-account, feel free to hit me up via e-mail (see [janraasch.com](https://www.janraasch.com)).
 
-
 ## Sponsor [![Pay me][insert-coins-svg]][paypal-dot-me]
+
 Please consider supporting my work on this theme via [GitHub Sponsors][github-sponsors] or [PayPal][paypal-dot-me].
 
 [![GitHub Stats](https://github-readme-stats.vercel.app/api/?username=janraasch)][github-sponsors]
 
 ## Special Thanks 🎁
 
-* Go to [Yonatan Wolowelsky](https://github.com/grmmph), for the great [GhostScroll](https://github.com/grmmph/GhostScroll)-theme which formed the basis of this [Hugo](https://gohugo.io/)-theme.
+- Go to [Yonatan Wolowelsky](https://github.com/grmmph), for the great [GhostScroll](https://github.com/grmmph/GhostScroll)-theme which formed the basis of this [Hugo](https://gohugo.io/)-theme.
-* Go to [Pexels](https://www.pexels.com), for supplying those wonderful *free* stock photos on the [exampleSite](https://github.com/janraasch/hugo-scroll/tree/master/exampleSite).
+- Go to [Pexels](https://www.pexels.com), for supplying those wonderful _free_ stock photos on the [exampleSite](https://github.com/janraasch/hugo-scroll/tree/master/exampleSite).
 
 ## License
+
 [MIT License](http://en.wikipedia.org/wiki/MIT_License) © [Jan Raasch](https://www.janraasch.com)
 
 [paypal-dot-me]: https://www.paypal.me/janraasch/29,00
 [github-sponsors]: https://github.com/sponsors/janraasch
 [insert-coins-svg]: https://img.shields.io/badge/insert-coins-11dde2.svg
-
 [hugo-setup-guide]: https://gohugo.io/getting-started/installing

archetypes/homepage.md

@@ -8,4 +8,5 @@ weight: 5
 # into the header menu at the top of the homepage.
 header_menu: true
 ---
+
 This is just another section to appear on the homepage.

exampleSite/content/homepage/about-me.md

@@ -1,8 +1,9 @@
 ---
-title: 'About Me'
+title: "About Me"
 weight: 3
 header_menu: true
 ---
+
 ![Jane Doe](images/happy-ethnic-woman-sitting-at-table-with-laptop-3769021.jpg)
 
 ##### Professionel Experience

exampleSite/content/homepage/contact.md

@@ -1,8 +1,9 @@
 ---
-title: 'Contact'
+title: "Contact"
 weight: 4
 header_menu: true
 ---
+
 E-Mail: [mail@janedoe.com](mailto:your-email@your-domain.com)
 
 Tel.: [+49 1111 555555](tel:+491111555555)

exampleSite/content/homepage/opener.md

@@ -1,5 +1,5 @@
 ---
-title: 'Welcome'
+title: "Welcome"
 weight: 1
 ---
 

exampleSite/content/homepage/services.md

@@ -1,8 +1,9 @@
 ---
-title: 'Services'
+title: "Services"
 weight: 2
 header_menu: true
 ---
+
 That is the important part, right? You want to know what I can do for you. This is why I put this right up there into the header menu of the website.
 
 ---

exampleSite/content/services.md

@@ -1,5 +1,5 @@
 ---
-title: 'Services'
+title: "Services"
 ---
 
 This is a page about the services, which I offer.

exampleSite/layouts/partials/custom_head.html

@@ -61,6 +61,20 @@
 <!-- Custom link-tags for different icons
      Generated via https://favicon.io/favicon-generator/ -->
 
-<link rel="apple-touch-icon" sizes="180x180" href='{{ "images/apple-touch-icon.png" | absURL }}'>
+<link
-<link rel="icon" type="image/png" sizes="32x32" href='{{ "images/favicon-32x32.png" | absURL }}'>
+  rel="apple-touch-icon"
-<link rel="icon" type="image/png" sizes="16x16" href='{{ "images/favicon-16x16.png" | absURL }}'>
+  sizes="180x180"
+  href="{{ "images/apple-touch-icon.png" | absURL }}"
+/>
+<link
+  rel="icon"
+  type="image/png"
+  sizes="32x32"
+  href="{{ "images/favicon-32x32.png" | absURL }}"
+/>
+<link
+  rel="icon"
+  type="image/png"
+  sizes="16x16"
+  href="{{ "images/favicon-16x16.png" | absURL }}"
+/>

layouts/404.html

@@ -1,5 +1,5 @@
 {{ define "main" }}
-<main class="content page-template 404" role="main">
+  <main class="content page-template 404" role="main">
     <article class="post page">
       <header class="post-header">
         <a id="blog-logo" href="{{ "/" | relURL }}">
@@ -8,8 +8,9 @@
       </header>
       <h1 class="post-title">404 - Page Not Found</h1>
       <section class="post-content">
-            Give it another try: <a href="{{ "/" | relURL }}" alt="Homepage">Back to the homepage</a>.
+        Give it another try:
+        <a href="{{ "/" | relURL }}" alt="Homepage">Back to the homepage</a>.
       </section>
     </article>
-</main>
+  </main>
 {{ end }}

layouts/_default/baseof.html

@@ -7,7 +7,10 @@
     {{- partial "footer.html" . -}}
 
     <!-- We do need jQuery to be loaded before HugoScroll script -->
-        <script type="text/javascript" src="https://code.jquery.com/jquery-1.11.3.min.js"></script>
+    <script
+      type="text/javascript"
+      src="https://code.jquery.com/jquery-1.11.3.min.js"
+    ></script>
 
     <!-- The main JavaScript files for HugoScroll -->
     <script type="text/javascript" src='{{ "js/icons.js" | absURL }}'></script>

layouts/_default/single.html

@@ -1,5 +1,5 @@
 {{ define "main" }}
-<main class="content page-template page-{{ .Slug }}" role="main">
+  <main class="content page-template page-{{ .Slug }}" role="main">
     <article class="post page">
       <header class="post-header">
         <a id="blog-logo" href="{{ "/" | relURL }}">
@@ -11,5 +11,5 @@
         {{ .Content }}
       </section>
     </article>
-</main>
+  </main>
 {{ end }}

layouts/index.html

@@ -14,7 +14,6 @@
             <i id='header-arrow' class="fa fa-angle-down"></i>
         </div>
     </div>
-
 </header>
 <main class="content" role="main">
 

layouts/partials/footer.html

@@ -1,11 +1,18 @@
 <footer class="site-footer">
   <div class="inner">
-        {{ with .Site.Params.copyright }}<section class="copyright">{{ . | markdownify }}</section>{{ end }}
+    {{ with .Site.Params.copyright }}
+      <section class="copyright">{{ . | markdownify }}</section>{{ end }}
+
+
     <section>{{ echoParam .Site.Params "hidebyline" }}</section>
-        {{ if ne .Site.Params.hidedesignbyline true }}<section>
+    {{ if ne .Site.Params.hidedesignbyline true }}
+      <section>
         <!-- TODO: Change link to https://themes.gohugo.io/hugo-scroll/ once
             https://github.com/gohugoio/hugoThemes/issues/881 is solved. -->
-            <a href="https://github.com/janraasch/hugo-scroll/">Design</a> template built with ♥️ by <a href="https://www.janraasch.com" title="Jan Raasch">Jan Raasch</a>
+        <a href="https://github.com/janraasch/hugo-scroll/">Design</a> template
+        built with ♥️ by
+        <a href="https://www.janraasch.com" title="Jan Raasch">Jan Raasch</a>
       </section>{{ end }}
+
   </div>
 </footer>

layouts/partials/head.html

@@ -3,20 +3,37 @@
 
 <title>{{ with .Title }}{{ . }}{{ else }}{{ .Site.Title }}{{ end }}</title>
 
-{{ with .Site.Params.favicon }}<link rel="shortcut icon" href="{{ . | absURL }}" type="image/png"/>{{ end }}
+{{ with .Site.Params.favicon }}
+  <link rel="shortcut icon" href="{{ . | absURL }}" type="image/png"
+/>{{ end }}
 
-{{ with .Site.Params.description }}<meta name="description" content="{{ . }}" />{{ end }}
+{{ with .Site.Params.description }}
-{{ with .Site.Params.meta.keywords }}<meta name="keywords" content="{{ . }}" />{{ end }}
+  <meta name="description" content="{{ . }}"
+/>{{ end }}
+{{ with .Site.Params.meta.keywords }}
+  <meta name="keywords" content="{{ . }}"
+/>{{ end }}
 <meta name="referrer" content="no-referrer-when-downgrade" />
 
 <meta name="HandheldFriendly" content="True" />
 <meta name="MobileOptimized" content="320" />
 <meta name="viewport" content="width=device-width, initial-scale=1.0" />
 
-<link rel="stylesheet" href='{{ "css/screen.css" | absURL }}'>
+<link rel="stylesheet" href="{{ "css/screen.css" | absURL }}" />
-<link href='https://fonts.googleapis.com/css?family=Open+Sans+Condensed:300,300italic,700' rel='stylesheet' type='text/css'>
+<link
-<link href='https://fonts.googleapis.com/css?family=Oswald:400,300,700|Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800|Roboto+Slab:400,100,300,700' rel='stylesheet' type='text/css'>
+  href="https://fonts.googleapis.com/css?family=Open+Sans+Condensed:300,300italic,700"
-<link rel="stylesheet" href='{{ "font-awesome/css/font-awesome.min.css" | absURL }}'>
+  rel="stylesheet"
+  type="text/css"
+/>
+<link
+  href="https://fonts.googleapis.com/css?family=Oswald:400,300,700|Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800|Roboto+Slab:400,100,300,700"
+  rel="stylesheet"
+  type="text/css"
+/>
+<link
+  rel="stylesheet"
+  href="{{ "font-awesome/css/font-awesome.min.css" | absURL }}"
+/>
 
 {{ template "_internal/opengraph.html" . }}
 {{ template "_internal/twitter_cards.html" . }}

package-lock.json

@@ -0,0 +1,20 @@
+{
+  "name": "hugo-scroll",
+  "version": "1.0.0",
+  "lockfileVersion": 1,
+  "requires": true,
+  "dependencies": {
+    "prettier": {
+      "version": "2.1.1",
+      "resolved": "https://registry.npmjs.org/prettier/-/prettier-2.1.1.tgz",
+      "integrity": "sha512-9bY+5ZWCfqj3ghYBLxApy2zf6m+NJo5GzmLTpr9FsApsfjriNnS2dahWReHMi7qNPhhHl9SYHJs2cHZLgexNIw==",
+      "dev": true
+    },
+    "prettier-plugin-go-template": {
+      "version": "0.0.10",
+      "resolved": "https://registry.npmjs.org/prettier-plugin-go-template/-/prettier-plugin-go-template-0.0.10.tgz",
+      "integrity": "sha512-TaHPqiMK/zfk+YhvKRf/1WZDgQ6ffnlxJZX5rwphqfxBOVEezZQtYistTB348MKrKnnwKpyXZWpMRo0/KCVB+A==",
+      "dev": true
+    }
+  }
+}

package.json

@@ -0,0 +1,29 @@
+{
+  "private": true,
+  "name": "hugo-scroll",
+  "version": "1.0.0",
+  "description": "A Hugo theme for pretty, quick and simple single-page websites.",
+  "main": "index.js",
+  "scripts": {
+    "test": "prettier --check . ",
+    "format": "prettier --write . "
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/janraasch/hugo-scroll.git"
+  },
+  "author": {
+    "name": "Jan Raasch",
+    "email": "jan@janraasch.com",
+    "url": "https://www.janraasch.com"
+  },
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/janraasch/hugo-scroll/issues"
+  },
+  "homepage": "https://github.com/janraasch/hugo-scroll#readme",
+  "devDependencies": {
+    "prettier": "^2.1.1",
+    "prettier-plugin-go-template": "0.0.10"
+  }
+}

static/js/index.js

@@ -2,121 +2,133 @@
  * Main JS file for GhostScroll behaviours
  */
 
-var $post = $('.post');
+var $post = $(".post");
-var $first = $('.post.first');
+var $first = $(".post.first");
-var $last = $('.post.last');
+var $last = $(".post.last");
-var $fnav = $('.fixed-nav');
+var $fnav = $(".fixed-nav");
-var $postholder = $('.post-holder');
+var $postholder = $(".post-holder");
-var $postafter = $('.post-after');
+var $postafter = $(".post-after");
-var $sitehead = $('#site-head');
+var $sitehead = $("#site-head");
 
 /* Globals jQuery, document */
 (function ($) {
   "use strict";
-	function srcTo (el) {
+  function srcTo(el) {
-		$('html, body').animate({
+    $("html, body").animate(
-			scrollTop: el.offset().top
+      {
-		}, 1000);
+        scrollTop: el.offset().top,
+      },
+      1000
+    );
   }
-	function srcToAnchorWithTitle (str) {
+  function srcToAnchorWithTitle(str) {
-		var $el = $('#' + str);
+    var $el = $("#" + str);
     if ($el.length) {
       srcTo($el);
     }
   }
-	$(document).ready(function(){
+  $(document).ready(function () {
-
     $postholder.each(function (e) {
-			if(e % 2 != 0)
+      if (e % 2 != 0) $(this).addClass("odd");
-				$(this).addClass("odd");
     });
 
     $postafter.each(function (e) {
-			var bg = $(this).parent().css('background-color')
+      var bg = $(this).parent().css("background-color");
-			$(this).css('border-top-color', bg);
+      $(this).css("border-top-color", bg);
 
       if (e % 2 == 0) {
         $(this).addClass("even");
       }
     });
 
-		$('a.btn.site-menu').click(function (e) {
+    $("a.btn.site-menu").click(function (e) {
-			srcToAnchorWithTitle($(e.target).data('title-anchor'));
+      srcToAnchorWithTitle($(e.target).data("title-anchor"));
     });
-		$('#header-arrow').click(function () {
+    $("#header-arrow").click(function () {
       srcTo($first);
     });
 
-		$('.post-title').each(function () {
+    $(".post-title").each(function () {
       var t = $(this).text();
-			var index = $(this).parents('.post-holder').index();
+      var index = $(this).parents(".post-holder").index();
-			$fnav.append("<a class='fn-item' item_index='"+index+"'>"+t+"</a>")
+      $fnav.append(
-			$('.fn-item').click(function () {
+        "<a class='fn-item' item_index='" + index + "'>" + t + "</a>"
-				var i = $(this).attr('item_index');
+      );
-				var s = $(".post[item_index='"+i+"']");
+      $(".fn-item").click(function () {
-
+        var i = $(this).attr("item_index");
-				$('html, body').animate({
+        var s = $(".post[item_index='" + i + "']");
-					scrollTop: s.offset().top
-				}, 400);
 
+        $("html, body").animate(
+          {
+            scrollTop: s.offset().top,
+          },
+          400
+        );
       });
     });
 
-		$('.post.last').next('.post-after').hide();
+    $(".post.last").next(".post-after").hide();
-		if($sitehead.length) {
+    if ($sitehead.length) {
-			$(window).scroll( function () {
+      $(window).scroll(function () {
         var w = $(window).scrollTop();
         var g = $sitehead.offset().top;
-				var h = $sitehead.offset().top + $sitehead.height()-100;
+        var h = $sitehead.offset().top + $sitehead.height() - 100;
 
-				if(w >= g && w<=h) {
+        if (w >= g && w <= h) {
-					$('.fixed-nav').fadeOut('fast');
+          $(".fixed-nav").fadeOut("fast");
-				} else if($(window).width()>500) {
+        } else if ($(window).width() > 500) {
-					$('.fixed-nav').fadeIn('fast');
+          $(".fixed-nav").fadeIn("fast");
         }
 
         $post.each(function () {
           var f = $(this).offset().top;
           var b = $(this).offset().top + $(this).height();
-					var t = $(this).parent('.post-holder').index();
+          var t = $(this).parent(".post-holder").index();
-					var i = $(".fn-item[item_index='"+t+"']");
+          var i = $(".fn-item[item_index='" + t + "']");
-					var a = $(this).parent('.post-holder').prev('.post-holder').find('.post-after');
+          var a = $(this)
+            .parent(".post-holder")
+            .prev(".post-holder")
+            .find(".post-after");
 
-					$(this).attr('item_index', t);
+          $(this).attr("item_index", t);
 
-					if(w >= f && w<=b) {
+          if (w >= f && w <= b) {
-						i.addClass('active');
+            i.addClass("active");
-						a.fadeOut('slow');
+            a.fadeOut("slow");
           } else {
-						i.removeClass('active');
+            i.removeClass("active");
-						a.fadeIn('slow');
+            a.fadeIn("slow");
           }
         });
       });
     }
 
-		$('ul li').before('<span class="bult fa fa-asterisk icon-asterisk"></span>');
+    $("ul li").before(
-		$('blockquote p').prepend('<span class="quo icon-quote-left"></span>');
+      '<span class="bult fa fa-asterisk icon-asterisk"></span>'
-		$('blockquote p').append('<span class="quo icon-quote-right"></span>');
+    );
+    $("blockquote p").prepend('<span class="quo icon-quote-left"></span>');
+    $("blockquote p").append('<span class="quo icon-quote-right"></span>');
   });
 
   $post.each(function () {
     var postText = $(this).html();
     var fa = [];
-		for(var i=0; i < icons.length; i++) {
+    for (var i = 0; i < icons.length; i++) {
       fa[i] = {};
-			fa[i].str   = "@"+ icons[i]+ "@";
+      fa[i].str = "@" + icons[i] + "@";
       fa[i].icon = icons[i];
       fa[i].int = postText.search(fa[i].str);
 
-			if(fa[i].int > -1 ) {
+      if (fa[i].int > -1) {
-				fa[i].count = postText.match(new RegExp(fa[i].str,"g")).length;
+        fa[i].count = postText.match(new RegExp(fa[i].str, "g")).length;
-				for(var j=0; j < fa[i].count; j++) {
+        for (var j = 0; j < fa[i].count; j++) {
-					$(this).html($(this).html().replace(fa[i].str, "<i class='fa "+fa[i].icon+"'></i>"))
+          $(this).html(
+            $(this)
+              .html()
+              .replace(fa[i].str, "<i class='fa " + fa[i].icon + "'></i>")
+          );
         }
       }
     }
   });
-
+})(jQuery);
-
-}(jQuery));