Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vfvong/jekyll-theme-quartz
A crystalline Jekyll theme for blog
https://github.com/vfvong/jekyll-theme-quartz
jekyll jekyll-blog jekyll-site jekyll-theme minimal-theme
Last synced: 2 months ago
JSON representation
A crystalline Jekyll theme for blog
- Host: GitHub
- URL: https://github.com/vfvong/jekyll-theme-quartz
- Owner: vfvong
- License: mit
- Created: 2022-08-31T12:00:44.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-10-19T12:26:52.000Z (about 2 years ago)
- Last Synced: 2024-09-29T02:42:24.407Z (3 months ago)
- Topics: jekyll, jekyll-blog, jekyll-site, jekyll-theme, minimal-theme
- Language: SCSS
- Homepage: http://vfvong.blog/jekyll-theme-quartz/
- Size: 3.34 MB
- Stars: 19
- Watchers: 1
- Forks: 15
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# Quartz
Quartz is a crystalline Jekyll theme for blog.
Check the [demo](http://vfvong.blog/jekyll-theme-quartz/).
## Highlight Features
- Support the CSS resets [Normalize](https://github.com/necolas/normalize.css)
- Support [Font Awesome](https://fontawesome.com/)
- Support [MathJax](https://www.mathjax.org/)
- Support [Disqus](https://disqus.com/)
- Support [Google Analytics 4](https://analytics.google.com/analytics/web/)
- Light and dark mode, via [`prefers-color-scheme`](https://web.dev/prefers-color-scheme/)
- Archive pages implemented in pure [Liquid](https://shopify.github.io/liquid/)
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [Basic Configuration](#basic-configuration)
- [Specifying the Page Language](#specifying-the-page-language)
- [Customizing the Head](#customizing-the-head)
- [Navigation](#navigation)
- [Social Links](#social-links)
- [Archive Pages](#archive-pages)
- [MathJax](#mathjax)
- [Disqus](#disqus)
- [Google Analytics 4](#google-analytics-4)
- [More Customization](#more-customization)
- [Contributing](#contributing)
- [Development](#development)
- [License](#license)
## Installation
Add this line to your Jekyll site's `Gemfile`:
```ruby
gem "jekyll-theme-quartz"
```
And add this line to your Jekyll site's `_config.yml`:
```yaml
theme: jekyll-theme-quartz
```
And then execute:
$ bundle
Or install it yourself as:
$ gem install jekyll-theme-quartz
If your website is hosted on GitHub Pages, you can install this theme via [`jekyll-remote-theme`](https://github.com/benbalter/jekyll-remote-theme).
Add the following to your `Gemfile`:
```ruby
gem "jekyll-remote-theme"
```
And add this line to your Jekyll site's `_config.yml`:
```yml
plugins:
- jekyll-remote-theme
```
Add the following to your site's `_config.yml`:
```yml
remote_theme: vfvong/jekyll-theme-quartz
```
## Usage
### Basic Configuration
You can refer to the [`_config.yml`](https://github.com/vfvong/jekyll-theme-quartz/blob/gh-pages/_config.yml) of the demo to set some basic configuration of your site.
### Specifying the Page Language
You can specify the language on each page by setting the `lang` property. If the property is not set, the `site.lang` would be referred. If the `site.lang` is not set, the default value `en` would be applied.
### Customizing the Head
If you want to put more data into the ``, you don't need to copy the whole `_includes/head.html` file from this repo and overwrite it in your repo. You just need to create a `_includes/custom-head.html` file in your repo, and put some data into there. These data will be automatically imported into the ``.
### Navigation
The navigation in Quartz is very easy to configure, just specify the titles and URLs in the [`_data/navigation.yml`](https://github.com/vfvong/jekyll-theme-quartz/blob/gh-pages/_data/navigation.yml) file, for example,
```yml
- title: Home
url: /
- title: About
url: /about.html
- title: Archive
url: /archive.html
```
### Social Links
The social links in Quartz is also very easy to connfigure. You don't need to import any large SVG file to render the icons because Quartz supports the [Font Awesome](https://fontawesome.com/). Specify the titles, URLs, and icons in the [`_data/social.yml`](https://github.com/vfvong/jekyll-theme-quartz/blob/gh-pages/_data/social.yml) file, for example,
```yml
- title: Email
url: mailto:[email protected]
icon: fas fa-envelope
- title: Twitter
url: https://twitter.com/vfvong
icon: fab fa-twitter
- title: GitHub
url: https://github.com/vfvong
icon: fab fa-github
```
### Archive Pages
Quartz provides a template `archive` to archive posts by years, categories, or tags.
If you want to show an archive page of years, just create a file and put these front matter in it:
```yml
---
layout: archive
type: years
title: Archive by Years
---
```
Similarly, if you want to show an archive page of categories, just create a file and put these front matter in it:
```yml
---
layout: archive
type: categories
title: Archive by Categories
---
```
Besides, if you want the categories and tags displayed in the post to link to the archive pages, you need to configure the paths to the category and tag archive pages in the `_config.yml` file, for example:
```yml
categories_path: /categories/
tags_path: /tags/
```
### MathJax
Quartz relies on the [MathJax](https://www.mathjax.org/) to render math. The MathJax is disabled by default. You need to set `math: true` on the page where you want to enable the MathJax.
### Disqus
To enable [Disqus](https://disqus.com/), just set the [Disqus shortname](https://help.disqus.com/en/articles/1717111-what-s-a-shortname) in the `_config.yml`, for example,
```yml
disqus:
```
### Google Analytics 4
Quartz support the [Google Analytics 4](https://support.google.com/analytics/answer/10089681). To enable it, just set the Measurement ID in the `_config.yml`, for example,
```yml
google_analytics: G-XXXXXXXXXX
```
### More Customization
You can easily modify some styles of this theme, such as colors and fonts. You don't have to copy a lot of CSS into your repository, just copy [`_sass/quartz/_variables.scss`](_sass/quartz/_variables.scss) and change the variable value.
## Contributing
Bug reports and pull requests are welcome on GitHub at [https://github.com/vfvong/jekyll-theme-quartz](https://github.com/vfvong/jekyll-theme-quartz). This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
## Development
To set up your environment to develop this theme, run `bundle install`.
Your theme is setup just like a normal Jekyll site! To test your theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`. This starts a Jekyll server using your theme. Add pages, documents, data, etc. like normal to test your theme's contents. As you make modifications to your theme and to your content, your site will regenerate and you should see the changes in the browser after a refresh, just like normal.
When your theme is released, only the files in `_layouts`, `_includes`, `_sass` and `assets` tracked with Git will be bundled.
To add a custom directory to your theme-gem, please edit the regexp in `jekyll-theme-quartz.gemspec` accordingly.
## License
The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).