Skip to content

Commit

Permalink
Flesh out README
Browse files Browse the repository at this point in the history
  • Loading branch information
benbalter committed Dec 13, 2016
1 parent 0e4e88a commit 64bf285
Showing 1 changed file with 68 additions and 38 deletions.
106 changes: 68 additions & 38 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,60 +1,90 @@
# `jekyll-theme-architect`
# The Architect theme

Architect is a Jekyll theme for [GitHub Pages](https://pages.github.com).
[![Build Status](https://travis-ci.org/pages-themes/jekyll-theme-architect.svg?branch=master)](https://travis-ci.org/pages-themes/jekyll-theme-architect) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-architect.svg)](https://badge.fury.io/rb/jekyll-theme-architect)

You can preview the theme at http://pages-themes.github.io/architect.
*Architect is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/architect), or even [use it today](#usage).*

### Usage
## Usage

This theme was ported from the GitHub Automatic Page Generator to a Jekyll v3.3 theme gem.
To use the Architect theme:

1. Add the following to your site's `_config.yml`:

```yml
theme: jekyll-theme-architect
```
2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:

```ruby
gem "github-pages", group: :jekyll_plugins
```

To use it on a Pages site, add `theme: jekyll-theme-architect` to your `_config.yml`.

```yml
theme: jekyll-theme-architect
title: Custom title
description: Custom description.
show_downloads: true
google_analytics:
```

- To override the repository name or description from GitHub used in the header, set a `title` or `description`.
- Set `show_downloads` to `false` to hide the download buttons in the header.
- Set `google_analytics` to your tracking ID to enable pageview tracking.
## Customizing

This theme includes a single `default` layout. Markdown files should be prefixed with the following frontmatter.
### Configuration variables

Architect will respect the following variables, if set in your site's `_config.yml`:

```yml
title: [The title of your site]
description: [A short description of your site's purpose]
```
---
layout: default
---

Additionally, you may choose to set the following optional variables:

```yml
show_downloads: ["true" or "false" to indicate whether to provide a download URL]
google_analytics: [Your Google Analytics tracking ID]
```

#### CSS
### Stylesheet

For CSS customization, create your own `/assets/css/styles.scss` in your project to replace the one from this theme, and override selected stylesheet properties.
If you'd like to add your own custom styles:

```css
---
---
1. Create a file called `/assets/css/style.css` in your site
2. Add the following content to the top of the file, exactly as shown:
```scss
---
---
@import "normalize";
@import "rouge-github";
@import 'architect';
```
@import "{{ site.theme }}";
```
3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line

#### Syntax Highlighting
### Layouts

[Rouge](http://rouge.jneen.net/) is the default highlighter in Jekyll 3. This theme includes the `github` stylesheet from Rouge.
If you'd like to change the theme's HTML layout:

To switch syntax highlighting colors to say `monokai`, install the `rouge` gem and run the following on the command line.
1. [Copy the original template](https://github.com/pages-themes/architect/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
2. Create a file called `/_layouts/default.html` in your site
3. Paste the default layout content copied in the first step
4. Customize the layout as you'd like

```
mkdir _scss
rougify style monokai > _scss/rouge-monokai.scss
```
## Roadmap

See the [open issues](https://github.com/pagse-themes/architect/issues) for a list of proposed features (and known issues).

## Project philosophy

The Architect theme is intended to make it quick and easy for GitHub Pages users to create their first (or 100th) website. The theme should meet the vast majority of users' needs out of the box, erring on the side of simplicity rather than flexibility, and provide users the opportunity to opt-in to additional complexity if they have specific needs or wish to further customize their experience (such as adding custom CSS or modifying the default layout). It should also look great, but that goes without saying.

## Contributing

Interested in contributing to Architect? We'd love your help. Architect is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](CONTRIBUTING.md) for instructions on how to contribute.

### Previewing the theme locally

If you'd like to preview the theme locally (for example, in the process of proposing a change):

1. Clone down the theme's repository (`git clone https://github.com/pages-themes/architect`)
2. `cd` into the theme's directory
3. Run `script/bootstrap` to install the necessary dependencies
4. Run `bundle exec jekyll serve` to start the preview server
5. Visit [`localhost:4000`](http://localhost:4000) in your browser to preview the theme

Then replace `rouge-github` with `rouge-monokai` in `/assets/css/styles.scss`
### Running tests

Other pygments highlighter themes should work as well.
The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` one before the test script will work.

0 comments on commit 64bf285

Please sign in to comment.