Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/clenemt/jackal

A very lightweight & responsive theme for Jekyll
https://github.com/clenemt/jackal

Last synced: 15 days ago
JSON representation

A very lightweight & responsive theme for Jekyll

Host: GitHub
URL: https://github.com/clenemt/jackal
Owner: clenemt
Created: 2016-07-12T16:42:35.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2019-03-03T11:52:10.000Z (over 5 years ago)
Last Synced: 2024-10-14T07:11:26.425Z (29 days ago)
Language: CSS
Homepage: https://clenemt.github.io/jackal/
Size: 70.3 KB
Stars: 82
Watchers: 2
Forks: 53
Open Issues: 4
Metadata Files:
- Readme: README.md

Awesome Lists containing this project

README

# Jackal ![](https://img.shields.io/npm/l/express.svg?maxAge=2592000?style=flat-square)
Jackal is a very lightweight theme for Jekyll.
Feel free to fork, change, modify and re-use it.

### Screenshots
![](https://cloud.githubusercontent.com/assets/447956/17020916/9ed9ce1a-4f44-11e6-80d5-26df9d219dd2.PNG)
![](https://cloud.githubusercontent.com/assets/447956/17020915/9ed939f0-4f44-11e6-9e8e-3a8e5562b0da.PNG)

# Usage
Be sure to have both `jekyll` and `jekyll-paginate` gem installed.

Than using your favorite terminal do:

```
$ git clone [email protected]:clenemt/jackal.git
$ cd jackal
$ jekyll serve
```

Jackal theme includes:

* Intro page
* About page
* Articles, archives and pagination
* Rss feed
* Responsive & great typo
* Code syntax highlighting
* Google Analytics tracking code

It can be seen in used at [clenemt.com](http://clenemt.com) or on [Github page](https://clenemt.github.io/jackal/).

## Options
See the global template options inside `config.yml` first thing.

Jackal also supports the following Front Matter options,

for **pages**:
* title (the page title)
* subtitle (the page h1)
* desc (for a SEO description /= excerpt)

for **posts**:
* microtitle (for a page title /= title)
* desc (for a manual excerpt and SEO description)

See [Front Matter](https://jekyllrb.com/docs/frontmatter/) and [configuration](https://jekyllrb.com/docs/configuration/) for more information.

# Thanks
Thanks to [Kactus](https://github.com/nickbalestra/kactus) and [jaicab]( https://github.com/jaicab/jaicab.github.io).

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.