Add a link in the header to GitHub repo

.gitattributes

@@ -0,0 +1,2 @@
+*.sh               text eol=lf
+aspell-dict.txt    text eol=lf

.github/workflows/actions.yml

@@ -0,0 +1,17 @@
+name: Test openplcproject.com Repository
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-20.04
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 2.7.3 # Not needed with a .ruby-version file
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+
+    - run: bundle exec rake checkhtml
+    - run: sudo apt-get update -y && sudo apt-get -y install aspell aspell-en locales
+    - run: echo "en_US UTF-8" | sudo tee -a /etc/locale.gen
+    - run: sudo locale-gen en_US.UTF-8
+    - run: export LANG=en_US.UTF-8 && export LANGUAGE=en_US:en && export LC_ALL=en_US.UTF-8 && bundle exec rake spellcheck

.gitignore

@@ -3,3 +3,6 @@ _site
 .jekyll-cache
 .jekyll-metadata
 vendor
+*.rws
+Gemfile.lock
+.bundle

CNAME

@@ -0,0 +1 @@
+www.openplcproject.com

Gemfile

@@ -30,4 +30,4 @@ gem "wdm", "~> 0.1.1", :install_if => Gem.win_platform?
 
 gem 'rake'
 gem 'jekyll-redirect-from'
-gem 'html-proofer'
+gem 'nokogiri', '>= 1.12.0'

README.md

@@ -1,7 +1,9 @@
 # openplcproject.github.io
 
+[![Build Status](https://travis-ci.com/openplcproject/openplcproject.github.io.svg?branch=master)](https://travis-ci.com/openplcproject/openplcproject.github.io)
+
 This project is the source for the OpenPLC Project's website, available
-at openplcproject.com. The site is built using the fantastic Jekyll static
+at openplcproject.com. We built the site using the fantastic Jekyll static
 site generator.
 
 ## Development
@@ -10,8 +12,16 @@ site generator.
 1. Run `bundle install`
 1. Run `bundle exec jekyll serve`
 
+You can (and should) run some simple tests with `bundle exec rake checkhtml`
+to check for common problems. The continuous integration build includes
+additional checks.
+
 ## Deploy
 
-TheGitHub repository hosted on openplc/openplcproject.github.io is configured
+The GitHub repository hosted on openplcproject/openplcproject.github.io is configured
 to automatically publish changes to the master branch. There is nothing you
 need to do.
+
+Builds published to GitHub automatically run a test build. The automated build
+checks for valid HTML and other common problems. The test currently does not
+run the spell check that can be run separately.

Rakefile

@@ -1,15 +1,61 @@
-require 'html-proofer'
+require 'nokogiri'
 
-task :test do
+task :checkhtml do
   sh "bundle exec jekyll build"
-  options = {
-    :assume_extension => true,
-    :allow_hash_href => true,
-    :check_favicon => true,
-    :check_html => true,
-    :checks_to_ignore => ["alt_ignore", "empty_alt_ignore"],
-    :empty_alt_ignore => true,
-    :disable_external => true
-  }
-  HTMLProofer.check_directory("./_site", options).run
+
+  num_with_errors = 0
+  last_error = ""
+  files = Dir['_site/**/*.html']
+  for file_name in files do
+    file = File.open(file_name).read
+    # Max errors is default to nil, which returns 0 error. This just
+    # needs any positive number of which 10 satisfies the conditions
+    begin
+      doc = Nokogiri::HTML5(file, max_errors: 10)
+
+      if doc.errors.length > 0
+        puts("Error: " + file_name + "\n")
+        doc.errors.each do |err|
+          puts(err)
+          last_error = err
+        end
+
+        num_with_errors += 1
+      else
+        puts("OK: " + file_name + "\n")
+      end
+    rescue => ex
+      puts("Error: " + file_name + "\n")
+      puts(ex)
+      num_with_errors += 1
+    end
+  end
+
+  if num_with_errors > 0
+    puts("Num files with errors:" + num_with_errors.to_s + "\n")
+    raise "One or more files contains an error. Last error: " + last_error
+  end
+end
+
+task :spellcheck do
+  sh "bundle exec jekyll build"
+  sh "aspell --lang=en create master ./aspell-dict.rws < ./aspell-dict.txt"
+
+  num_with_errors = 0
+  last_error = ""
+  files = Dir['_site/**/*.html']
+  for file_name in files do
+    misspelled = `cat #{file_name} | aspell --list -H --html-skip=script --add-html-skip=style --add-html-skip=pre --add-html-skip=code --extra-dicts=./aspell-dict.rws | sed '/^$/d'`
+    if misspelled.length > 0
+      puts("Error: " + file_name + " words: " + misspelled)
+      num_with_errors += 1
+    else
+      puts("OK: " + file_name)
+    end
+  end
+
+  if num_with_errors > 0
+    puts("Num files with errors:" + num_with_errors.to_s + "\n")
+    raise "One or more files contains an misspelling. Add false positives to aspell-dict.txt"
+  end
 end

_config.yml

@@ -18,16 +18,15 @@
 # You can create any custom variable you would like, and they will be accessible
 # in the templates via {{ site.myvariable }}.
 
-title: Your awesome title
+title: OpenPLC Project
 email: [email protected]
 description: >- # this means to ignore newlines until "baseurl:"
   Write an awesome description for your new site here. You can edit this
   line in _config.yml. It will appear in your document head meta (for
   Google search results) and in your feed.xml site description.
 baseurl: "" # the subpath of your site, e.g. /blog
 url: "" # the base hostname & protocol for your site, e.g. http://example.com
-twitter_username: jekyllrb
-github_username:  jekyll
+github_username:  openplcproject
 
 # Build settings
 theme: minima
@@ -38,6 +37,12 @@ plugins:
 whitelist:
   - jekyll-redirect-from
 
+collections:
+  posts:
+    output: true
+    permalink: /blog/:year/:month/:day/:title
+
+
 # Exclude from processing.
 # The following items will not be processed, by default.
 # Any item listed under the `exclude:` key here will be automatically added to

_data/carousel.yml

@@ -1,13 +1,13 @@
 images: 
-    - image: /assets/img/carousel/daughtercards.webp
-    - image: /assets/img/carousel/zumlink.webp
-    - image: /assets/img/carousel/mega.webp
-    - image: /assets/img/carousel/pixtend.webp
-    - image: /assets/img/carousel/raspberrypi.webp
-    - image: /assets/img/carousel/small.webp
-    - image: /assets/img/carousel/zumlink.webp
-    - image: /assets/img/carousel/zumiq.webp
-    - image: /assets/img/carousel/unipi.webp
-    - image: /assets/img/carousel/modbusio.webp
-    - image: /assets/img/carousel/arduino.webp
+    - image: /assets/img/carousel/daughtercards.png
+    - image: /assets/img/carousel/zumlink.png
+    - image: /assets/img/carousel/mega.png
+    - image: /assets/img/carousel/pixtend.png
+    - image: /assets/img/carousel/raspberrypi.png
+    - image: /assets/img/carousel/small.png
+    - image: /assets/img/carousel/zumlink.png
+    - image: /assets/img/carousel/zumiq.png
+    - image: /assets/img/carousel/unipi.png
+    - image: /assets/img/carousel/modbusio.png
+    - image: /assets/img/carousel/arduino.png
 

_includes/development.html

@@ -0,0 +1,13 @@
+<div class="admonitionblock important">
+  <table>
+  <tbody><tr>
+  <td class="icon">
+  <div class="title">Important</div>
+  </td>
+  <td class="content">
+  This section describes capabilities only in the <code>development</code> branch.
+  You must checkout the <code>development</code> branch to use these capabilities.
+  </td>
+  </tr>
+  </tbody></table>
+</div>

_includes/firstproject.md

@@ -5,11 +5,11 @@ The [Reference](/reference) menu on this website has a nice tutorial that
 teaches you [how to create your first project](/reference-your-first-project).
 However, if you're in a hurry, you can download the official Hello World
 project, which is basically one rung, a button, a timer and a coil, all
-connected together. The button is attached to %IX0.0 and the coil is attached
-to %QX0.0. When the button is pressed and released, the coil is energized and
+connected together. The button is attached to `%IX0.0` and the coil is attached
+to `%QX0.0`. When the button is pressed and released, the coil is energized and
 remains on for 2 seconds, and then turns off.
 
-<img src="/runtime/img/myprogram.webp" alt=""/>
+<img src="/runtime/img/myprogram.png" alt=""/>
 
 Download the project below and open it on [OpenPLC Editor](/plcopen-editor).
 Click on Generate

_includes/footer.html

@@ -1,9 +1,17 @@
 <footer>
   <div class="pure-g inset">
-    <div class="pure-u-1 footer__title">Contact</div>
-    <hr class="pure-u-1" />
-    <div class="pure-u-1 footer_item">Thiago Alves</div>
-    <div class="pure-u-1 footer_item">Mail: <a href="mailto:[email protected]">[email protected]</a></div>
-    <hr class="pure-u-1" />
+    <div class="pure-u-1-3">
+      <div class="footer__title">
+        CONTACT
+      </div>
+      <div class="footer_item">Thiago Alves</div>
+      <div class="footer_item">Mail: <a href="mailto:[email protected]">[email protected]</a></div>
+    </div>
+    <div class="pure-u-1-3">
+
+    </div>
+    <div class="pure-u-1-3" style="text-align:right">
+      <a href="//github.com/openplcproject/openplcproject.github.io/blob/master/{{page.path}}"><i class='fa fa-pencil'></i> Edit this page</a>
+    </div>
   </div>
 </footer>

_includes/important.html

@@ -0,0 +1,12 @@
+<div class="admonitionblock important">
+  <table>
+  <tbody><tr>
+  <td class="icon">
+  <div class="title">Important</div>
+  </td>
+  <td class="content">
+    {{ include.content }}
+  </td>
+  </tr>
+  </tbody></table>
+</div>

_includes/inset-dev.html

@@ -0,0 +1,11 @@
+---
+layout: default
+---
+
+<article class="inset">
+  <h1>{{ page.title }}</h1>
+
+  {%include development.html %}
+
+  {{ content }}
+</article>

_includes/install.md

@@ -10,3 +10,6 @@ The installation process will take a while (up to 1 hour depending on your
 system). Meanwhile, grab a [insert your favorite beverage here] and relax!
 Once OpenPLC is installed, just reboot your device and it will start
 automatically after boot.
+
+{% include tip.html content="To use in-development capabilities, checkout the
+`development` branch (`git checkout development`) prior to running `install.sh`." %}

_includes/login.md

@@ -5,7 +5,7 @@ accessed by opening a web browser on your computer and typing the IP address
 of your OpenPLC device at port 8080. For example, if your {{ include.devicename }}
 has the IP 192.168.0.103 on your network, you should type this on your browser:
 
-<img src="/runtime/img/ipaddress.webp" alt=""/>
+<img src="/runtime/img/ipaddress.png" alt=""/>
 
 If you don't know the IP address of your board, the Raspberry Pi foundation
 has a [nice guide](https://www.raspberrypi.org/documentation/remote-access/ip-address.md)
@@ -14,15 +14,15 @@ to help you out.
 Once you access OpenPLC webserver, you should see in your browser window a
 login page like this:
 
-<img src="/runtime/img/login.webp" alt=""/>
+<img src="/runtime/img/login.png" alt=""/>
 
 The default username and password is openplc (login) and openplc (password).
 This means that the first thing you must do after logging in for the first
 time is **change the default username and password**! It is very easy to do
 that. Just go to the Users menu, click on the OpenPLC User and change the
 information as you like.
 
-<img src="/runtime/img/edituser.webp" alt=""/>
+<img src="/runtime/img/edituser.png" alt=""/>
 
 Once you save the changes you will be prompted to login again. Just login with
 your new credentials and you will be good to go!

_includes/menu.html

@@ -1,14 +1,14 @@
 <nav>
   <div class="custom-wrapper pure-g inset" id="menu">
-    <div class="pure-u-1 pure-u-md-1-3">
+    <div class="pure-u-1 pure-u-md-1-4">
       <div class="pure-menu">
-        <a href="/" class="pure-menu-heading custom-brand">
-          <img src="/assets/img/openplc-white.gif" alt="Go to home page" class="header__logo"/>
+        <a href="/" class="pure-menu-heading">
+          <img src="/assets/img/openplc-white.png" alt="Go to home page" class="header__logo"/>
         </a>
         <a href="#" class="custom-toggle" id="toggle"><s class="bar"></s><s class="bar"></s></a>
       </div>
     </div>
-    <div class="pure-u-1 pure-u-md-2-3">
+    <div class="pure-u-1 pure-u-md-3-4">
       <div class="pure-menu pure-menu-horizontal custom-menu-3 custom-can-transform">
         {% assign current = page.url | downcase | split: '/' %}
 
@@ -18,6 +18,8 @@
               Started</a></li>
           <li class="pure-menu-item"><a href="/reference" class="pure-menu-link{% if current[1] == 'reference' %} current{% endif %}">Reference</a></li>
           <li class="pure-menu-item"><a href="http://openplc.discussion.community/" class="pure-menu-link">Forum</a></li>
+          <li class="pure-menu-item"><a href="/blog" class="pure-menu-link{% if current[1] == 'blog' %} current{% endif %}">Blog</a></li>
+          <li class="pure-menu-item"><a href="//github.com/thiagoralves/OpenPLC_v3" alt="Contribute on GitHub"><i class='fa fa-github'></i></a></li>
         </ul>
       </div>
     </div>

_includes/note.html

@@ -0,0 +1,3 @@
+<p class="note">
+    {{ include.content }}
+</p>

_includes/tip.html

@@ -0,0 +1,12 @@
+<div class="admonitionblock tip">
+  <table>
+  <tbody><tr>
+  <td class="icon">
+  <div class="title">Tip</div>
+  </td>
+  <td class="content">
+    {{ include.content | markdownify }}
+  </td>
+  </tr>
+  </tbody></table>
+</div>