TheParanoidTimes: Just like the name

#The Paranoid Times Website and Capsule

My personal blog / portfolio Website and Capsule made with Jekyll.

#Installation

Jekyll requires that Ruby is installed and most operations are done using Bundler. Ruby, and Jekyll provide the best experience on Unix environments. This guide is made for Ubuntu (and Ubuntu on Windows WSL).

To install prerequisites:

sudo apt-get install ruby-full build-essential zlib1g-dev

Prepare Ruby environment:

echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

Install Jekyll and Bundler gems:

gem install jekyll bundler

To set-up the project:

git clone git@git.sr.ht:~tpt/theparanoidtimes.org
cd theparanoidtimes.org
bundle install

Occasionally it is good to update the Bundler (see Gemfile.lock):

bundle update --bundler

To update the gem dependencies (see Gemfile):

bundle update jekyll
bundle update jekyll-sitemap
bundle update jekyll-feed
bundle update jekyll-gemini

Or reference the gems by group:

bundle update --group jekyll_plugins

The same project is used to build both the Website and the Capsule from the same sources.

#Website

To clean the output directory and cache:

./clean.sh

To start a development server:

bundle exec jekyll serve

This will serve the site on: localhost:4000. Jekyll will watch for any changes and automatically apply them on the running site.

To just build the site:

bundle exec jekyll build

This will output the site to the _site directory.

#Capsule

To clean the output directory and cache:

./clean.sh

To build the capsule:

bundle exec jekyll gemini

This will output the Capsule in the _capsule directory.

There is no equivalent to serve for the Capsule so there must be an external Gemini server. JetForce is a great option. It is not required, but it's always good to use the Python virtualenv. To set up the virtual environment Python is required, but it should be present on any Ubuntu instance.

Ensure pip is present:

sudo apt-get install pip
# or to update pip
python3 -m pip install --upgrade pip

To install JetForce in the project directory:

python3 -m pip install --user virtualenv
python3 -m virtualenv .venv
source .venv/bin/activate
pip install jetforce

JetForce is present in the Python virtual environment only and it can be used to serve the Capsule:

bundle exec jekyll gemini
jetforce --dir _capsule/

This will serve the Capsule on gemini://localhost:1965. A Gemini client is required to access it such as AV-98, Lagrange or Elpher.

The server will listed to any changes in the referenced directory and serve them without the need to restart. Since it listens to the _capsule directory every time new changes are made Jekyll will need to rebuild the Capsule with the gemini command.

When done deactivate the virtual environment:

deactivate

#Theme

The theme is a modification of BlackDoc theme.

#Content license

The content of this site is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.

#License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

~tpt/TheParanoidTimes