Rawfeed — A raw Jekyll theme for minimalists
Theme Preview

Requirements

Required	Version	How to verify	How to install
Git	>= 2	git -v	Git
Ruby	>= 3.0	ruby -v	Ruby
Gem	>= 3.0	gem -v	Ruby contains Gem
Bundler	>= 2.0	bundler -v	gem install bundler
NodeJs	>= 20	node -v	NodeJS
Npm	>= 9	npm -v	NodeJS contains Npm

Features

• [x] One-command installation (via Unix|PowerShell);
• [x] A terminal emulator on the home page with commands;
• [x] Commands for manipulating page headers, posts and drafts in markdown;
• [x] Smart floating TOC in posts;
• [x] Theme change: light/dark;
• [x] Chart in posts;
• [x] Stylized Markdown;
• [x] Avatar opens in modal with inversion animation for each different theme (light/dark);
• [x] Enables and Disables weblog;
• [x] Home page with about or blog, you decide with one command;
• [x] A quick search field on the weblog using keyword and date;
• [x] Weblog pagination;
• [x] YouTube video in weblog posts;
• [x] Social network link on the home page or by command in the terminal;
• [x] Feed in weblog;
• [x] SEO-rich website;
• [x] Entire site minified in build: html, images, css and javascript.
• [x] Maintenance page;
• [x] Comments on blog posts with Giscus or Disqus (only in production [jekyll build]);
• [x] Google Analytics (only in production [jekyll build]);

Installation

In the terminal/Command Prompt, run the commands below according to the OS.

Unix:

curl -fsSL https://williamcanin.github.io/install/rawfeed | sh

Windows:

iwr -useb https://williamcanin.github.io/install/rawfeed | iex

Usage

(1) - Install dependencies:

npm install

(2) - For rawfeed manipulation commands, use:

npm run help

Settings

Avatar

(1) - Create the folder directory: assets/images.

(2) - Place your website's images (.jpg|.png) inside this assets/images directory.

Recommendation: Use a 4x4 image.

(3) - In the _config.yml file, in the section: [avatar], change the value of "avatar.image" to the name of your images. For example:

avatar:
  open: true
  flip: true
  # note: the image (.jpg|.png) will be searched in the directory: assets/images/
  image:
    front:
      light: your_image_light.png
      dark: your_image_dark.png
    back: your_image_back.png

Posts

Creating a blog post is very easy, first you create a draft (npm run draft) and after you finish the draft, you move it to the post with the command npm run posts.

Note: If you start the server (npm run serve), drafts will appear in posts, but they will not go into production mode (npm run build).

Comments:

Post comments use Giscus or Disqus, configurable in the _config.yml file under section: [blog]. Whichever one you choose, you must set the appropriate settings in the _config.yml file under section: [blog], and each post must have comments: true set.

To learn more about both, such as how to set them up, visit Giscus or Disqus.

For developer

Clone and install:

git clone https://github.com/williamcanin/rawfeed.git; cd rawfeed; npm install

Manage gem:

(1) - Compile the gem:

npm run gem

(2) - Publish the gem:

npm run publish

For more tasks, see: bundle exec rake --tasks

Donation

Click on the image below to be redirected the donation forms:

See the list of our CONTRIBUTORS.

License

The theme is available as open source under the terms of this License.