https://github.com/daaain/cohousing

https://github.com/daaain/cohousing

Last synced: about 1 year ago
JSON representation

• Host: GitHub
• URL: https://github.com/daaain/cohousing
• Owner: daaain
• License: mit
• Created: 2014-03-15T23:55:02.000Z (about 12 years ago)
• Default Branch: gh-pages
• Last Pushed: 2014-03-23T14:25:32.000Z (about 12 years ago)
• Last Synced: 2024-10-06T03:20:19.325Z (over 1 year ago)
• Language: CSS
• Size: 1.16 MB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
Scribble

========

A jekyll theme. [Want a demo? click and read instruction. :point_left:](http://scribble.muan.co/2013/05/06/scribble-the-jekyll-theme/)




[More themes](https://github.com/muan/muan.github.com/releases).

![screenshot](http://scribble.muan.co/images/screenshot.png)

There is no clever design philosophy to talk about, I tried to find something to work with, and 'scribble' came to my mind. 

This theme uses Open Sans powered by Google Web Fonts, and was written in plain HTML, SCSS & CoffeeScript, though .scss & .coffee files wouldn't be included in the theme. 

The theme is mobile optimised but I did not check browser compatibility. It looks great in Chrome, Safari and Firefox though.

---

### Get started

1. [Fork the repository](https://github.com/muan/scribble/fork).

2. Clone the repository to your computer.
 `git clone https://github.com/username/scribble`

3. `bundle install`

4. **Using older versions of Jekyll**


  Build and run jekyll using `jekyll --server --auto`.


  **Using [Jekyll 1.0](http://blog.parkermoore.de/2013/05/06/jekyll-1-dot-0-released/)**


  Build Jekyll using `jekyll build`.


  Then run Jekyll using `jekyll serve --watch`, go to http://localhost:4000 for your site.

---

### Make it yours

1. I have extract most user specific information to `_config.yml`, you should be able to set up almost everything from it.

2. Change about.md for blog intro.

3. For domain settings, see [the guide from GitHub](https://help.github.com/articles/setting-up-a-custom-domain-with-pages).

---

### GitHub Pages stuff

The `gh-pages` branch of this repository is [the project page](http://scribble.muan.co), which **should not** be used as your blog, so use `master` branch for your blog. This is assuming your blog repository will be called [your-username].github.io, if tis is not the case, you will need to delete the `gh-pages` repository and create a branch off the `master` branch. Hope that's clear.

---

### Options

When writing a post, there are 3 options you can add to the header.

1. **disqus: y**


  If disqus is set to 'y', at the end of the post there will be a disqus thread, just like this one. To use disqus, you MUST [set up your own disqus account](http://disqus.com/).

2. **share: y**


  An option for showing tweet and like button under a post.

3. **date**: 2013-05-06 18:07:17


  Date is not a required header since Jekyll reads the file name for date, this was added in only for the **signoff time**. (as shown at the end of this post) If you don't want the signoff time, go into `/includes/signoff.html` remove the ``, and remove `{% include signoff.html %}` from `/layouts/post.html`.

---

### The end

Like it? [Tell me](http://twitter.com/muanchiou).


Question? [Use GitHub Issues](https://github.com/muan/scribble/issues).