4.2 KiB
layout
layout |
---|
default |
_ _ _ _ _ >(')____, >(')____, >(')____, >(')____, >(') ___, (` =~~/ (` =~~/ (` =~~/ (` =~~/ (` =~~/ jgs~^~^`---'~^~^~^`---'~^~^~^`---'~^~^~^`---'~^~^~^`---'~^~^~
Duckquill
Duckquill is a modern, pretty, and clean Jekyll template that has the purpose of greatly simplifying the process of rolling up your blog. It aims to let you write simple markdown pages and deploy them to Codeberg or GitLab Pages.
Edit a bit of metadata and tweak some of the included graphics and have a blog up in minutes!
- Pretty, yet lightweight. No JavaScript are used.
- Proper favicon for modern browsers and Apple device icons.
- Mastodon, Lemmy and other social media meta cards for easy sharing. Try Share Preview to test.
- Local copy of the amazing Inter font. No slowdowns pulling from external hosting.
- Mobile friendly, with proper dark variant included.
- jekyll-compress-html and jekyll-loading-lazy are included for better experience on slow networks.
- github-pages-like experience without actual
github-pages
plugin, since it has a lot of useless stuff like default Jekyll themes, plus some GitHub-specific stuff. - Mastodon-powered comments. Comment using any ActivityPub service by replying to Mastodon post.
See demo for showcase of all Duckquill possibilities. Oh and comments demo for showcase of Mastodon-powered comments.
Make yourself a cup of your favorite drink and let's start!
Preparation
This template needs a CI to be built and deployed, using either Codeberg or GitLab Pages are recommended. For Codeberg Pages I've written a blog post on step-by-step guide how to get the CI working.
There is an included .woodpecker.yml
and .gitlab-ci.yml
that should be easy to adjust to your situation. For additional info see Codeberg Pages and GitLab Pages docs.
Getting started
This template includes some useful utilities to make your life easier and keep you sane (looking at you, ruby stuff).
The process of setting up the site locally consists of:
-
Install Podman. On Fedora Silverblue it's already installed
-
Run
local.sh build
to create a Podman container that uses official Jekyll image, download and install all needed Gems and build the site locally. -
Edit the Jekyll config file --
_config.yml
. -
Replace all mentions and links of
Daudix
andDuckquill
with yours. -
Replace or edit all the graphics. Using Inkscape are recommended. If you want to reduce the SVGs size, use svgo.
-
Add/override styles by doing so in
_sass/custom.scss
. doing this instead of modifying styles directly are strongly recommended, as it will allow you to update Duckquill easily. -
Test the site locally. Run
local.sh serve
. -
git commit
your changes and push to your remote repo for automatic deployment.
Special thanks ♥
- Jakub Steiner for an awesome OS Component Website, on top of which this whole thing is built
- Cassidy James for an awesome Mastodon-powered comments
- dwb, ejm and jgs for awesome ASCII art