Merge pull request #21 from wiserfirst/feat/update-readme

Update readme and remove unnecessary deps

Author: wiserfirst

.github/workflows/ci.yml

@@ -11,10 +11,6 @@ jobs:
     env:
       # speeds up installation of htmlproofer
       NOKOGIRI_USE_SYSTEM_LIBRARIES: true
-      # NOTE: The minimal-mistakes-generated 404 page seems to have a #main
-      # hash href to nowhere, so ignore all #main hash links for now; I don't
-      # have any that I've created in any pages that I control.
-      HTMLPROOFER_IGNORE_HREFS: '/localhost/,#main,/medium.com/,/twitter.com/,/docs.github.com/,/gnu.org/,/pixabay.com/,/www.allaboutsymbian.com/,/iteye.com/blog/,/www.williamlong.info/,/mademistakes.com/'
 
     steps:
       - name: Clone repository
@@ -40,32 +36,6 @@ jobs:
       - name: Run markdownlint
         run: markdownlint _posts _drafts _pages README.md
 
-        # Explanations for flags:
-        # --allow-hash-href - Build will fail on the first and last post entries
-        # if this isn't allowed since there will be previous and next buttons
-        # that have 'links to nowhere'.
-        # --assume-extension - Jekyll 3 supports extensionless URLs, and
-        # the blog uses them, so this flag needs to be here to prevent errors.
-        # --url-ignore "/localhost/" - Posts have explicit references to
-        # localhost, so don't consider them proper external links that need to
-        # go anywhere.
-        # --http-status-ignore "999" - LinkedIn doesn't seem to like crawlers,
-        # and hence sends back 999 errors, even if the link is valid.
-        # --disable-external - Only use this if the build fails unreasonably on
-        # external links
-        # NOTE: If a new post is created or new tags are introduced via a post,
-        # htmlproofer will need to be disabled for a build in order to proceed
-        # forward
-        # - name: Run htmlproofer
-        #   run: >
-        #     bundle exec htmlproofer _site
-        #     --no-enforce-https
-        #     --no-check-external-hash
-        #     --allow-hash-href
-        #     --ignore-urls $HTMLPROOFER_IGNORE_HREFS
-        #     --ignore-status-codes "999"
-        #     --typhoeus '{"ssl_verifypeer": false, "ssl_verifyhost": 0}'
-
       - name: Deploy to Netlify
         if: success()
         uses: South-Paw/action-netlify-cli@v2

.travis.yml

@@ -11,18 +11,6 @@ ruby '3.1.2'
 # This will help ensure the proper Jekyll version is running.
 gem 'jekyll', '~> 4.0'
 
-group :development do
-  # Command line tool to easily handle events on file system modifications
-  gem 'guard', '~> 2.16'
-  # Guard extension to run cli processes
-  gem 'guard-process', '~> 1.2'
-end
-
-group :development, :test do
-  # Test your rendered HTML files to make sure they're accurate
-  gem 'html-proofer', '~> 5.0.1'
-end
-
 # the theme
 # If you have any plugins, put them here!
 group :jekyll_plugins do

Gemfile

@@ -8,61 +8,28 @@ GEM
       tzinfo (~> 2.0)
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
-    async (2.3.1)
-      console (~> 1.10)
-      io-event (~> 1.1)
-      timers (~> 4.1)
-    coderay (1.1.3)
     colorator (1.1.0)
     concurrent-ruby (1.2.2)
-    console (1.16.2)
-      fiber-local
     cssminify2 (2.0.1)
     em-websocket (0.5.3)
       eventmachine (>= 0.12.9)
       http_parser.rb (~> 0)
-    ethon (0.16.0)
-      ffi (>= 1.15.0)
     eventmachine (1.2.7)
     execjs (2.8.1)
     faraday (2.6.0)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
     faraday-net_http (3.0.1)
     ffi (1.15.5)
-    fiber-local (1.0.0)
-    formatador (1.1.0)
     forwardable-extended (2.6.0)
     gemoji (3.0.1)
-    guard (2.18.0)
-      formatador (>= 0.2.4)
-      listen (>= 2.7, < 4.0)
-      lumberjack (>= 1.0.12, < 2.0)
-      nenv (~> 0.1)
-      notiffany (~> 0.0)
-      pry (>= 0.13.0)
-      shellany (~> 0.0)
-      thor (>= 0.18.1)
-    guard-compat (1.2.1)
-    guard-process (1.2.1)
-      guard-compat (~> 1.2, >= 1.2.1)
-      spoon (~> 0.0.1)
     html-pipeline (2.14.3)
       activesupport (>= 2)
       nokogiri (>= 1.4)
-    html-proofer (5.0.3)
-      addressable (~> 2.3)
-      async (~> 2.1)
-      nokogiri (~> 1.13)
-      rainbow (~> 3.0)
-      typhoeus (~> 1.3)
-      yell (~> 2.0)
-      zeitwerk (~> 2.5)
     htmlcompressor (0.4.0)
     http_parser.rb (0.8.0)
     i18n (1.14.1)
       concurrent-ruby (~> 1.0)
-    io-event (1.1.4)
     jekyll (4.3.1)
       addressable (~> 2.4)
       colorator (~> 1.0)
@@ -117,9 +84,7 @@ GEM
     listen (3.7.1)
       rb-fsevent (~> 0.10, >= 0.10.3)
       rb-inotify (~> 0.9, >= 0.9.10)
-    lumberjack (1.2.8)
     mercenary (0.4.0)
-    method_source (1.0.0)
     mini_portile2 (2.8.5)
     minimal-mistakes-jekyll (4.24.0)
       jekyll (>= 3.7, < 5.0)
@@ -129,24 +94,16 @@ GEM
       jekyll-paginate (~> 1.1)
       jekyll-sitemap (~> 1.3)
     minitest (5.19.0)
-    nenv (0.3.0)
     nokogiri (1.16.2)
       mini_portile2 (~> 2.8.2)
       racc (~> 1.4)
-    notiffany (0.1.3)
-      nenv (~> 0.1)
-      shellany (~> 0.0)
     octokit (4.25.1)
       faraday (>= 1, < 3)
       sawyer (~> 0.9)
     pathutil (0.16.2)
       forwardable-extended (~> 2.6)
-    pry (0.14.1)
-      coderay (~> 1.1)
-      method_source (~> 1.0)
     public_suffix (5.0.1)
     racc (1.7.3)
-    rainbow (3.1.1)
     rb-fsevent (0.11.2)
     rb-inotify (0.10.1)
       ffi (~> 1.0)
@@ -159,31 +116,19 @@ GEM
     sawyer (0.9.2)
       addressable (>= 2.3.5)
       faraday (>= 0.17.3, < 3)
-    shellany (0.0.1)
-    spoon (0.0.6)
-      ffi
     terminal-table (3.0.2)
       unicode-display_width (>= 1.1.1, < 3)
-    thor (1.2.1)
-    timers (4.3.5)
-    typhoeus (1.4.0)
-      ethon (>= 0.9.0)
     tzinfo (2.0.6)
       concurrent-ruby (~> 1.0)
     uglifier (4.2.0)
       execjs (>= 0.3.0, < 3)
     unicode-display_width (2.3.0)
     webrick (1.7.0)
-    yell (2.2.2)
-    zeitwerk (2.6.6)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  guard (~> 2.16)
-  guard-process (~> 1.2)
-  html-proofer (~> 5.0.1)
   jekyll (~> 4.0)
   jekyll-archives (~> 2.2)
   jekyll-feed (~> 0.15)

Gemfile.lock

@@ -6,33 +6,33 @@ This is the codebase for my personal blog at [`wiserfirst.com`][], created with
 
 ## Install
 
-### Install Ruby
-
-Ruby is required to run Jekyll and it can be installed with [`asdf`][] as
-follows:
+### Clone the Repository
 
 ```sh
-asdf plugin add ruby
-asdf install ruby 2.7.2
-asdf global ruby 2.7.2
+git clone [email protected]:wiserfirst/wiserfirst.github.io.git
+cd wiserfirst.github.io
 ```
 
-### Clone the Repository
+### Install Ruby and Nodejs
+
+Ruby is required to run Jekyll and Nodejs is needed to run a development
+dependency markdownlint. They can be installed with [`asdf`][] as
+follows:
 
 ```sh
-git clone [email protected]:wiserfirst/wiserfirst.github.io.git
-cd wiserfirst.github.io
-bundle install
+asdf plugin add ruby
+asdf plugin add nodejs
+# need to run in this directory
+asdf install
 ```
 
+
 ### Development Dependencies
 
 This app uses the following dependencies during development:
 
 - [markdownlint][] (via [markdownlint-cli][]): make sure Markdown syntax
   conforms to community standards
-- [HTMLProofer][]: make sure HTML rendered files are accurate and do not have
-  broken links etc
 
 Install [Node][]-based dependencies in the following way, and remember to
 re-shim whatever version manager is being used for Node (I use [`asdf`][]), or
@@ -44,8 +44,6 @@ npm install --global markdownlint-cli
 asdf reshim nodejs
 ```
 
-HTMLProofer is a Ruby gem and so Bundler will bring it into the project.
-
 ## Usage
 
 ### Start blog server
@@ -56,45 +54,17 @@ bundle exec jekyll serve --incremental --drafts --livereload
 
 Then, navigate to <http://localhost:4000>
 
-### Monitor files
-
-This project uses [Guard][] to monitor file changes.
-
-Start Guard with the following command:
-
-```sh
-bundle exec guard
-```
-
 ## Theme
 
 This blog currently uses the [Minimal Mistakes][] theme.
 
 ## Deployment
 
-This blog is current deployed to [Netlify][] with [Travis CI][] running the
+This blog is current deployed to [Netlify][] with [Github Actions][] running the
 builds.
 
 Just push to the `develop` branch to trigger a new build and if the build is
-successful, site would be built and pushed to the `release` branch. Then a new
-deployment will be triggered on Netlify, since it monitors the `release` branch.
-
-The only caveat is when there is a new post, the following section in travis
-yaml file (which runs `htmlproofer`) needs to be commented out for the build to
-pass:
-
-```yaml
-  - >
-    bundle exec htmlproofer _site
-    --allow-hash-href
-    --assume-extension
-    --url-ignore "/localhost/,/facebook.com\/sharer\/sharer.php/,#main,/iteye.com\/blog/,/www.williamlong.info/"
-    --http-status-ignore "999"
-    --typhoeus-config '{"ssl_verifypeer": false, "ssl_verifyhost": 0}'
-```
-
-Once the site is deployed with the new post, `htmlproofer` can be re-enabled
-again in a follow up commit.
+successful, the site would be deployed to Netlify.
 
 ## License
 
@@ -111,10 +81,8 @@ under the [MIT license][license-mit-url].
 SPDX-License-Identifier: (MIT AND CC-BY-4.0)
 
 [`asdf`]: https://github.com/asdf-vm/asdf
-[Build Status image]: https://travis-ci.com/wiserfirst/wiserfirst.github.io.svg?branch=develop
-[Build Status url]: https://travis-ci.com/github/wiserfirst/wiserfirst.github.io
-[Guard]: https://github.com/guard/guard
-[HTMLProofer]: https://github.com/gjtorikian/html-proofer
+[Build Status image]: https://github.com/wiserfirst/wiserfirst.github.io/actions/workflows/ci.yml/badge.svg
+[Build Status url]: https://github.com/wiserfirst/wiserfirst.github.io/actions/workflows/ci.yml
 [Jekyll]: https://jekyllrb.com
 [license-cc-badge]: https://licensebuttons.net/l/by/4.0/80x15.png
 [license-cc-url]: https://creativecommons.org/licenses/by/4.0/legalcode
@@ -127,5 +95,5 @@ SPDX-License-Identifier: (MIT AND CC-BY-4.0)
 [Netlify Status image]: https://api.netlify.com/api/v1/badges/e997650f-fd0c-44c5-a6a5-1488dad7d879/deploy-status
 [Netlify Status url]: https://app.netlify.com/sites/elastic-villani-588077/deploys
 [Node]: https://github.com/nodejs/node
-[Travis CI]: https://travis-ci.com/
+[Github Actions]: https://github.com/features/actions
 [`wiserfirst.com`]: https://www.wiserfirst.com