Ghost theme for https://sd.ai/ - forked from Source (https://github.com/TryGhost/Source)

Go to file

Simon Detheridge 346f3de193 Remove unneeded settings		2023-10-17 14:46:43 +01:00
assets	Mastodon improvements	2023-10-17 14:18:00 +01:00
partials	Remove unneeded settings	2023-10-17 14:46:43 +01:00
.gitignore	Initial commit	2023-07-05 20:43:09 +08:00
author.hbs	Various improvements	2023-09-18 17:50:05 +08:00
default.hbs	Remove unneeded settings	2023-10-17 14:46:43 +01:00
gulpfile.js	Updated the theme name in other places	2023-09-15 17:47:56 +08:00
home.hbs	Various improvements	2023-09-18 17:50:05 +08:00
index.hbs	Various improvements	2023-09-18 17:50:05 +08:00
LICENSE	Added the license	2023-10-03 15:55:25 +08:00
package.json	Remove unneeded settings	2023-10-17 14:46:43 +01:00
page.hbs	Bug fixes	2023-08-07 19:58:36 +08:00
post.hbs	Mastodon improvements	2023-10-17 14:18:00 +01:00
README.md	Update README	2023-10-17 10:19:33 +01:00
tag.hbs	Various improvements	2023-09-18 17:50:05 +08:00
yarn.lock	Update dependency gscan to v4.39.4	2023-10-03 13:08:40 +02:00

README.md

sd.ai Ghost Theme

Forked from Source - the default theme for Ghost.

Styles the site as it looked previously and adds Mastodon support and a theme switcher.

First time using a Ghost theme?

Ghost uses a simple templating language called Handlebars for its themes.

This theme has lots of code comments to help explain what's going on just by reading the code. Once you feel comfortable with how everything works, we also have full theme API documentation which explains every possible Handlebars helper and template.

The main files are:

default.hbs - The parent template file, which includes your global header/footer
home.hbs - The homepage
index.hbs - The main template to generate a list of posts
post.hbs - The template used to render individual posts
page.hbs - Used for individual pages
tag.hbs - Used for tag archives, eg. "all posts tagged with news"
author.hbs - Used for author archives, eg. "all posts written by Jamie"

One neat trick is that you can also create custom one-off templates by adding the slug of a page to a template file. For example:

page-about.hbs - Custom template for an /about/ page
tag-news.hbs - Custom template for /tag/news/ archive
author-ali.hbs - Custom template for /author/ali/ archive

Development

Source styles are compiled using Gulp/PostCSS to polyfill future CSS spec. You'll need Node, Yarn and Gulp installed globally. After that, from the theme's root directory:

# install dependencies
yarn install

# run development server
yarn dev

Now you can edit /assets/css/ files, which will be compiled to /assets/built/ automatically.

The zip Gulp task packages the theme files into dist/<theme-name>.zip, which you can then upload to your site.

# create .zip file
yarn zip

PostCSS Features Used

Autoprefixer - Don't worry about writing browser prefixes of any kind, it's all done automatically with support for the latest 2 major versions of every browser.

SVG Icons

Source uses inline SVG icons, included via Handlebars partials. You can find all icons inside /partials/icons. To use an icon just include the name of the relevant file, eg. To include the SVG icon in /partials/icons/rss.hbs - use {{> "icons/rss"}}.

You can add your own SVG icons in the same manner.