-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
0d75eb4
commit ff57636
Showing
109 changed files
with
1,066 additions
and
3,386 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,10 @@ | ||
<html> | ||
<head> | ||
<meta content='Scribble' property='og:title' /> | ||
<title>Scribble</title> | ||
<link href='{{ site.url }}/images/fav.png' rel='shortcut icon'> | ||
<link href='{{ site.url }}/stylesheets/style.css' rel='stylesheet' type='text/css' /> | ||
<link href='{{ site.url }}/stylesheets/responsive.css' rel='stylesheet' type='text/css' /> | ||
<!-- - --> | ||
<script src='{{ site.url }}/javascripts/jquery.js' type='text/javascript'></script> | ||
<!-- - --> | ||
<meta content='width=device-width, initial-scale=1.0, user-scalable=no' name='viewport'> | ||
<meta content='text/html; charset=utf-8' http-equiv='content-type' /> | ||
<meta content='{{ site.url }}' property='og:url' /> | ||
<meta content="A jekyll theme. Because I scribble." property='og:description' /> | ||
<meta content="blog" property="og:type" /> | ||
</head> | ||
<body> | ||
<div class="a-c"> | ||
<img src="{{ site.url }}/images/404.png" alt="not found" width="160" /> | ||
<p> | ||
<a href="{{ site.url }}" class="main" target="_top">Back</a> | ||
</p> | ||
</div> | ||
</body> | ||
</html> | ||
--- | ||
layout: default | ||
title: "404: Page not found" | ||
permalink: 404.html | ||
--- | ||
|
||
<div class="page"> | ||
<h1 class="page-title">404: Page not found</h1> | ||
<p class="lead">Sorry, we've misplaced that URL or it's pointing to something that doesn't exist. <a href="{{ site.baseurl }}/">Head back home</a> to try finding it again.</p> | ||
</div> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
# Released under MIT License | ||
|
||
Copyright (c) 2013 Mark Otto. | ||
|
||
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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,121 @@ | ||
Scribble | ||
======== | ||
# Poole | ||
|
||
A Jekyll theme. [Want a demo? click and read instruction. :point_left:](http://scribble.muan.co/2013/05/06/scribble-the-jekyll-theme/) | ||
<br /> | ||
[More themes](https://github.com/muan/muan.github.com/releases). | ||
*The Strange Case of Dr. Jekyll and Mr. Hyde* tells the story of a lawyer investigating the connection of two persons, Dr. Henry Jekyll and Mr. Edward Hyde. Chief among the novel's supporting cast is a man by the name of Mr. Poole, Dr. Jekyll's loyal butler. | ||
|
||
![screenshot](https://cloud.githubusercontent.com/assets/1153134/11014801/12c7940a-853e-11e5-9f7b-87325c9bc695.png) | ||
----- | ||
|
||
There is no clever design philosophy to talk about, I tried to find something to work with, and 'scribble' came to my mind. | ||
Poole is the butler for [Jekyll](http://jekyllrb.com), the static site generator. It's designed and developed by [@mdo](https://twitter.com/mdo) to provide a clear and concise foundational setup for any Jekyll site. It does so by furnishing a full vanilla Jekyll install with example templates, pages, posts, and styles. | ||
|
||
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. | ||
![Poole](https://f.cloud.github.com/assets/98681/1834359/71ae4048-73db-11e3-9a3c-df38eb170537.png) | ||
|
||
The theme is mobile optimized but I did not check browser compatibility. It looks great in Chrome, Safari and Firefox though. | ||
See Poole in action with [the demo site](http://demo.getpoole.com). | ||
|
||
--- | ||
There are currently two official themes built on Poole: | ||
|
||
### Get started | ||
* [Hyde](http://hyde.getpoole.com) | ||
* [Lanyon](http://lanyon.getpoole.com) | ||
|
||
1. [Fork the repository](https://github.com/muan/scribble/fork). | ||
2. Clone the repository to your computer.<br /> `git clone https://github.com/username/scribble` | ||
3. `bundle install` | ||
4. **Using older versions of Jekyll**<br /> | ||
Build and run Jekyll using `jekyll --server --auto`.<br /> | ||
**Using [Jekyll 1.0](http://blog.parkermoore.de/2013/05/06/jekyll-1-dot-0-released/)**<br /> | ||
Build Jekyll using `jekyll build`.<br /> | ||
Then run Jekyll using `jekyll serve --watch`, go to http://localhost:4000 for your site. | ||
Individual theme feedback and bug reports should be submitted to the theme's individual repository. | ||
|
||
--- | ||
|
||
### Make it yours | ||
## Contents | ||
|
||
1. I have extracted 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). | ||
- [Usage](#usage) | ||
- [Options](#options) | ||
- [Rems, `font-size`, and scaling](#rems-font-size-and-scaling) | ||
- [Development](#development) | ||
- [Author](#author) | ||
- [License](#license) | ||
|
||
--- | ||
|
||
### Options | ||
## Usage | ||
|
||
When writing a post, there are 3 options you can add to the header. | ||
### 1. Install dependencies | ||
|
||
1. **disqus: y**<br /> | ||
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/). | ||
Poole is built on Jekyll and uses its built-in SCSS compiler to generate our CSS. Before getting started, you'll need to install the Jekyll gem: | ||
|
||
2. **share: y**<br /> | ||
An option for showing tweet and like button under a post. | ||
```bash | ||
$ gem install jekyll | ||
``` | ||
|
||
3. **date**: 2013-05-06 18:07:17<br /> | ||
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 `<span>`, and remove `{% include signoff.html %}` from `/layouts/post.html`. | ||
**Windows users:** Windows users have a bit more work to do, but luckily [@juthilo](https://github.com/juthilo) has your back with his [Run Jekyll on Windows](https://github.com/juthilo/run-jekyll-on-windows) guide. | ||
|
||
--- | ||
**Need syntax highlighting?** Poole includes support for Pygments or Rouge, so install your gem of choice to make use of the built-in styling. Read more about this [in the Jekyll docs](http://jekyllrb.com/docs/templates/#code_snippet_highlighting). | ||
|
||
### The end | ||
### 2a. Quick start | ||
|
||
Like it? [Tell me](http://twitter.com/muanchiou).<br/> | ||
Question? [Use GitHub Issues](https://github.com/muan/scribble/issues). | ||
To help anyone with any level of familiarity with Jekyll quickly get started, Poole includes everything you need for a basic Jekyll site. To that end, just download Poole and start up Jekyll. | ||
|
||
### 2b. Roll your own Jekyll site | ||
|
||
Folks wishing to use Jekyll's templates and styles can do so with a little bit of manual labor. Download Poole and then copy what you need (likely `_layouts/`, `*.html` files, `atom.xml` for RSS, and `public/` for CSS, JS, etc.). | ||
|
||
### 3. Running locally | ||
|
||
To see your Jekyll site with Poole applied, start a Jekyll server. In Terminal, from `/poole` (or whatever your Jekyll site's root directory is named): | ||
|
||
```bash | ||
$ jekyll serve | ||
``` | ||
|
||
Open <http://localhost:4000> in your browser, and voilà. | ||
|
||
### 4. Serving it up | ||
|
||
If you host your code on GitHub, you can use [GitHub Pages](https://pages.github.com) to host your project. | ||
|
||
1. Fork this repo and switch to the `gh-pages` branch. | ||
1. If you're [using a custom domain name](https://help.github.com/articles/setting-up-a-custom-domain-with-github-pages), modify the `CNAME` file to point to your new domain. | ||
2. If you're not using a custom domain name, **modify the `baseurl` in `_config.yml`** to point to your GitHub Pages URL. Example: for a repo at `github.com/username/poole`, use `http://username.github.io/poole/`. **Be sure to include the trailing slash.** | ||
3. Done! Head to your GitHub Pages URL or custom domain. | ||
|
||
No matter your production or hosting setup, be sure to verify the `baseurl` option file and `CNAME` settings. Not applying this correctly can mean broken styles on your site. | ||
|
||
## Options | ||
|
||
Poole includes some customizable options, typically applied via classes on the `<body>` element. | ||
|
||
|
||
### Rems, `font-size`, and scaling | ||
|
||
Poole is built almost entirely with `rem`s (instead of pixels). `rem`s are like `em`s, but instead of building on the immediate parent's `font-size`, they build on the root element, `<html>`. | ||
|
||
By default, we use the following: | ||
|
||
```css | ||
html { | ||
font-size: 16px; | ||
line-height: 1.5; | ||
} | ||
@media (min-width: 38em) { | ||
html { | ||
font-size: 20px; | ||
} | ||
} | ||
|
||
``` | ||
|
||
To easily scale your site's typography and components, simply customize the base `font-size`s here. | ||
|
||
|
||
## Development | ||
|
||
Poole has two branches, but only one is used for active development. | ||
|
||
- `master` for development. **All pull requests should be to submitted against `master`.** | ||
- `gh-pages` for our hosted site, which includes our analytics tracking code. **Please avoid using this branch.** | ||
|
||
CSS is handled via Jeykll's built-in Sass compiler. Source Sass files are located in `_sass/`, included into `styles.scss`, and compile to `styles.css`. | ||
|
||
## Author | ||
|
||
**Mark Otto** | ||
- <https://github.com/mdo> | ||
- <https://twitter.com/mdo> | ||
|
||
|
||
## License | ||
|
||
Open sourced under the [MIT license](LICENSE.md). | ||
|
||
<3 |
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.