Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/TryGhost/Argon

A simple publishing theme for Ghost
https://github.com/TryGhost/Argon

blogging ghost ghost-theme publishing

Last synced: 3 months ago
JSON representation

A simple publishing theme for Ghost

Host: GitHub
URL: https://github.com/TryGhost/Argon
Owner: TryGhost
License: mit
Created: 2019-11-17T16:06:22.000Z (almost 5 years ago)
Default Branch: main
Last Pushed: 2023-07-06T13:54:53.000Z (over 1 year ago)
Last Synced: 2024-04-14T12:07:36.518Z (7 months ago)
Topics: blogging, ghost, ghost-theme, publishing
Language: CSS
Homepage: https://argon.ghost.io
Size: 699 KB
Stars: 22
Watchers: 10
Forks: 5
Open Issues: 6
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-starred - TryGhost/Argon - A simple publishing theme for Ghost (publishing)

README

# Argon

A simple publishing theme for [Ghost](https://ghost.org)

# First time using a Ghost theme?

Ghost uses a simple templating language called [Handlebars](http://handlebarsjs.com/) for its themes.

We've documented our default theme pretty heavily so that it should be fairly easy to work out what's going on just by reading the code and the comments. Once you feel comfortable with how everything works, we also have full [theme API documentation](https://themes.ghost.org) which explains every possible Handlebars helper and template.

**The main files are:**

- `default.hbs` - The main template file
- `index.hbs` - Used for the home page
- `post.hbs` - Used for individual posts
- `page.hbs` - Used for individual pages
- `tag.hbs` - Used for tag archives
- `author.hbs` - Used for author archives

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

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

# Development

Styles are compiled using Gulp/PostCSS to polyfill future CSS spec. You'll need [Node](https://nodejs.org/), [Yarn](https://yarnpkg.com/) and [Gulp](https://gulpjs.com) installed globally. After that, from the theme's root directory:

```bash
# Install
yarn

# Run build & watch for changes
$ 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/.zip`, which you can then upload to your site.

```bash
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.
- Variables - Simple pure CSS variables
- [Color Function](https://github.com/postcss/postcss-color-function)