https://github.com/ahmadajmi/type
🎉 Minimal and Clean Free Jekyll Theme
https://github.com/ahmadajmi/type
blog blog-theme clean clean-jekyll-theme itcss jekyll jekyll-theme minimal sass system-fonts theme
Last synced: 27 days ago
JSON representation
🎉 Minimal and Clean Free Jekyll Theme
- Host: GitHub
- URL: https://github.com/ahmadajmi/type
- Owner: ahmadajmi
- License: mit
- Created: 2017-09-25T11:27:16.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2024-07-24T11:38:23.000Z (9 months ago)
- Last Synced: 2025-03-29T18:08:44.267Z (about 1 month ago)
- Topics: blog, blog-theme, clean, clean-jekyll-theme, itcss, jekyll, jekyll-theme, minimal, sass, system-fonts, theme
- Language: SCSS
- Homepage: https://type-jekyll.aspirethemes.com/
- Size: 1.36 MB
- Stars: 215
- Watchers: 7
- Forks: 141
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Type: Minimal and Clean Free Jekyll Theme
- [Configurations](#configurations)
- [Deployment](#deployment)
- [Posts](#posts)
- [Pages](#pages)
- [Navigation](#navigation)
- [Disqus Comments](#disqus-comments)
- [Social Media Links](#social-media-links)
- [Update favicon](#update-favicon)
### Configurations
Type theme comes with different customizations in the `_config.yml` file:
```sh
title: Type
email: ''
description: ''
baseurl: '' # The subpath of your site, e.g. /blog
url: '' # The base hostname & protocol for your site
twitter: ''
github: ''
instagram: ''
facebook: ''
markdown: kramdown
permalink: pretty
paginate: 60
sass:
style: compressed
gems:
- jekyll-paginate
- jekyll/tagging
include:
- _pages
exclude:
- vendor
- Gemfile
- Gemfile.lock
# Tags
tag_page_dir: tag
tag_page_layout: tag_page
tag_permalink_style: pretty
# Pages path
defaults:
- scope:
path: '_pages'
values:
permalink: /:basename:output_ext
```
### Deployment
To run the theme locally, navigate to the theme directory and run `bundle install` to install the dependencies, then run `jekyll serve` to start the Jekyll server.
I would recommend checking the [Deployment Methods](https://jekyllrb.com/docs/deployment-methods/) page on Jekyll website.
### Posts
To create a new post, you can create a new markdown file inside the `_posts` directory by following the [recommended file structure](https://jekyllrb.com/docs/posts/#creating-post-files).
The following is a post file with different configurations you can add as an example:
```sh
---
layout: post
title: Welcome to Jekyll!
featured: true
tags: [frontpage, jekyll, blog]
image: '/images/welcome.jpg'
---
```
You can set the author, featured or not, tags, and the post image.
The `featured` key is to mark the post as a featured post, this will add a simple star icon (*) to the postcard.
To keep things more organized, add post images to **/images/posts** directory, and add page images to **/images/pages** directory.
To create a draft post, create the post file under the **_drafts** directory, and you can find more information at [Working with Drafts](http://jekyllrb.com/docs/drafts/).
For tags, try to not add space between two words, for example, `Ruby on Rails`, could be something like (`ruby-on-rails`, `Ruby_on_Rails`, or `Ruby-on-Rails`).
Note that tags are not working with GitHub Pages, that's because the used [jekyll-tagging
](https://github.com/pattex/jekyll-tagging) plugin is not [whitelisted](https://pages.github.com/versions/) by GitHub.
To make this work, I use [Netlify.com](https://www.netlify.com/) for deployment.
### Pages
To create a new page, just create a new markdown file inside the `_pages` directory.
The following is the `about.md` file that you can find as an example included in the theme with the configurations you can set.
```sh
---
layout: page
title: About
image: '/images/pages/about.jpeg'
---
```
Things you can change are: `title` and `image` path.
### Navigation
The navigation on the sidebar will automatically include all the links to the pages you have created.
### Disqus Comments
Open `_includes/disqus.html` file, and change the `aspirethemes-demos` value on line `12` with your [Disqus account shortname](https://help.disqus.com/customer/portal/articles/466208).
```js
s.src = '//aspirethemes-demo.disqus.com/embed.js';
```
So, if your Disqus shortname is `exampleone`, the final code above should be
```js
s.src = '//exampleone.disqus.com/embed.js';
```
That's all you need to setup Disqus from the theme side. If you get any issue regarding that comments are unable to load. First, make sure you have [registered your website with Disqus (Step 1)](https://help.disqus.com/customer/portal/articles/466182-publisher-quick-start-guide)
And also check [Disqus troubleshooting guide](https://help.disqus.com/customer/portal/articles/472007-i-m-receiving-the-message-%22we-were-unable-to-load-disqus-%22) if you still have issues.
### Social Media Links
Social media links included in `_includes/footer.html` file.
The theme is using [Evil Icons](http://evil-icons.io/), which contains very simple and clean icons. The following is a list of the social media icons to use:
Twitter
```html
```
Facebook
```html
```
Instagram
```html
```
Pinterest
```html
```
Vimeo
```html
```
Google Plus
```html
```
SoundCloud
```html
```
Tumblr
```html
```
Youtube
```html
```
### Update favicon
You can find the current favicon (favicon.ico) inside the theme root directory, just replace it with your new favicon.
### Aspire Themes
👉 Visit [**aspirethemes.com**](http://bit.ly/type-jekyll-github-link) for more Jekyll, Ghost, and WordPress themes.
---
