trenton / effective-shell

Text, samples and website for my 'Effective Shell' series.

effective-shell

Text, samples and references for my 'Effective Shell' series. This website is hosted at effective-shell.com.

If you find this book useful, please do consider sponsoring me to help support my open-source work!

<iframe src="https://github.com/sponsors/dwmkerr/button" title="Sponsor dwmkerr" height="35" width="116" style="border: 0;"></iframe>

• Introduction
• Installing the Samples
• The Website
  • Building the Website
  • Updating the Theme
• Versioning
• Copyright & Licensing
• Thanks!

Introduction

This repository contains all of the content for the Effective Shell online book.

Installing the Samples

You can install the samples into your ~/effective-shell folder with this command:

curl effective.sh | sh

Or can also manually download them using from any of these locations:

• https://effective-shell.com/downloads/effective-shell-samples.zip
• https://effective-shell.com/downloads/effective-shell-samples.tar.gz

The one-line shell installer is hosted at github.com/dwmkerr/effective-shell-installer

The Website

The content in this repository is built into a static site available at effective-shell.com. This is done using Hugo.

This section contains information on how to built, use and edit the site. To help you quickly edit the site, some tips are below:

• The main content is at website/content/docs/
• The menu structure is defined at website/content/menu/index.md.

Building the Website

This website is built with Hugo. It is very easy to setup and run locally.

To setup dependencies, run:

make setup

To serve the site locally, run:

make serve

To build the site, run:

make build

The built site is generated at ./website/public.

Note that the samples folder is automatically zipped up and added to the website, meaning it can be downloaded directly from:

https://effective-shell.com/downloads/effective-shell-samples.zip
https://effective-shell.com/downloads/effective-shell-samples.tar.gz

Updating the Theme

The site uses the github.com/dwmkerr/hugo-book theme, which is a fork of alex-shpak.

Versioning

The version of the site and the code is defined in the version.txt file. This makes it reasonably straightforward to script actions which require the version.

Releasing in managed via Release Please in the release-please.yaml workflow file.

Copyright & Licensing

All content is Copyright (©) Dave Kerr. Please get in touch by opening an issue if you have questions on copyright or licensing.

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 3.0 Unported License.

Thanks!

Thanks to the following people who have helped with reviews, comments, suggestions.

• Andrew Bestbier, Thomas Neumann, Tam Nguyen, Rahul Maliakkal, Peter Mondlock, Samantha Baldwin, Niklas Schmuecker for the useful comments and suggestions
• Ogus Ismail for helping me understand some of the nuances of word splitting and filename expansion