Sha256: 61f3332a496a361690499cb99f4e84f57159260c3595a426181d664f0a6564ad

Contents?: true

Size: 1.23 KB

Versions: 3

Compression:

Stored size: 1.23 KB

Contents

# arco

Arco is a responsive fixed-sidebar layout with a two column masonry grid which also features a landing page, a 404 page and a simple permalink structure.

## Installation

Add this line to your Jekyll site's `Gemfile`:

```ruby
gem "arco"
```

And add this line to your Jekyll site's `_config.yml`:

```yaml
theme: arco
```

And then execute:

    $ bundle

Or install it yourself as:

    $ gem install arco

## Usage

### Site configuration

The following settings can be configured in your site's `_config.yml`

```yaml
title: Site title
description: Site description
image: /assets/image.png
github_url: https://github.com/meebuhs
resume: true | false
```

### Expected post frontmatter

```
---
layout: post
title: Post title
summary: Post summary
category: completed | ongoing
permalink: /projects/post-title
cover-image: /assets/image-for-front-page.png
top-image: /assets/image-for-top-of-post.png 
mathjax: true | false
---
```

### Resume support

To add a resume to the site, set `resume: true` in your `_config.yml`.
Then create a folder called `_includes` at the root of your site and add your `resume.html` to it.

## License

The theme is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

Version data entries

3 entries across 3 versions & 1 rubygems

Version Path
arco-0.3.1 README.md
arco-0.3.0 README.md
arco-0.2.0 README.md