Skip to content

Commit

Permalink
renew
Browse files Browse the repository at this point in the history
  • Loading branch information
villanella committed Nov 13, 2015
1 parent 46e8efe commit bbd1c9f
Show file tree
Hide file tree
Showing 195 changed files with 3,373 additions and 9,006 deletions.
25 changes: 25 additions & 0 deletions 404.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<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>
3 changes: 0 additions & 3 deletions CHANGELOG.md

This file was deleted.

1 change: 0 additions & 1 deletion CNAME

This file was deleted.

4 changes: 2 additions & 2 deletions Gemfile
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
source "https://rubygems.org"
source 'http://rubygems.org'

gem "github-pages", ">= 25"
gem 'github-pages'
21 changes: 21 additions & 0 deletions LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2013 Mu-An Chiou

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.
156 changes: 33 additions & 123 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,147 +1,57 @@
# :ribbon: Hi! I'm Shiori, a Bootstrap-based Jekyll Theme. :ribbon:
Scribble
========

![](https://cloud.githubusercontent.com/assets/992008/3955483/2b9a77ae-2702-11e4-9f28-6afb051271de.png)
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).

## :ribbon: Live Demo :ribbon:
![screenshot](https://cloud.githubusercontent.com/assets/1153134/11014801/12c7940a-853e-11e5-9f7b-87325c9bc695.png)

### [You can view the live demo of myself here](http://ellekasai.github.io/shiori).
There is no clever design philosophy to talk about, I tried to find something to work with, and 'scribble' came to my mind.

## :ribbon: Screenshots :ribbon:
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.

### Desktop/Tablet

![](http://cl.ly/image/3a2M1D3E3b3d/screenshot%202014-08-30%20at%206.51.34%20PM.png)

## :ribbon: Color Schemes :ribbon:

I wear different colors (based on [Flat UI Colors](http://flatuicolors.com/)):

### Dark

![](http://cl.ly/image/3d3T3b3E0b45/screenshot%202014-08-30%20at%206.48.56%20PM.png)

---

### Turquoise

![](http://cl.ly/image/1s1k3m1E3n37/screenshot%202014-08-30%20at%206.49.02%20PM.png)
The theme is mobile optimized but I did not check browser compatibility. It looks great in Chrome, Safari and Firefox though.

---

### Green
### Get started

![](http://cl.ly/image/0G0G3u392I11/screenshot%202014-08-30%20at%206.49.08%20PM.png)
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.

---

### Blue
### Make it yours

![](http://cl.ly/image/1V1C0n2U0c1s/screenshot%202014-08-30%20at%206.49.14%20PM.png)
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).

---

### Purple
### Options

![](http://cl.ly/image/1V283M0f1K08/screenshot%202014-08-30%20at%206.49.19%20PM.png)
When writing a post, there are 3 options you can add to the header.

---
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/).

### Orange
2. **share: y**<br />
An option for showing tweet and like button under a post.

![](http://cl.ly/image/2d2k010J3z3g/screenshot%202014-08-30%20at%206.49.24%20PM.png)
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`.

---

### Red

![](http://cl.ly/image/10080E2G3c1e/screenshot%202014-08-30%20at%206.49.31%20PM.png)

---

## :ribbon: Usage :ribbon:

**Note:** If you're not familiar with Jekyll, please read up on [Jekyll's documentation](http://jekyllrb.com/) first.

[Fork this repo](http://github.com/ellekasai/shiori/fork), clone it, and then run:

```
bundle install
```

...which installs `github-pages` gem. After that, run the server:

```
jekyll serve --watch
```

### :warning: Warning :warning:

Once the server is started, you must go to [http://localhost:4000/shiori/](http://localhost:4000/shiori/), since `baseurl` is set as `"/shiori"` initially.

To use http://localhost:4000/, change `baseurl` in `_config.yml` to `""` .

### Keeping Shiori Up to Date

To keep Shiori up to date, follow these steps:

1. [Configure a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork)
2. [Sync a fork](https://help.github.com/articles/syncing-a-fork) (**Note**: Use `gh-pages` instead of `master`.)

## :ribbon: Customization :ribbon:

### Required

You **should** change these files before deploying:

* `_config.yml`: You must change `baseurl`, `url`, and `title`. Others are optional.
* Make sure to restart the server after you update `_config.yml`.
* `CNAME`: Change this to host Shiori on a custom domain.
* `README.md`: Write your own README!
* `_includes/nav.html`: Modify or remove navigation links.
* `_includes/nav-right.html`: Modify or remove navigation links.
* `_includes/sidebar.html`: Customize the side bar.
* `_includes/post-header.html`: Customize the post header.
* `_includes/post-footer.html`: Customize the post footer.
* `_includes/footer.html`: Add copyright info, etc.

### Optional

You **may** customize these files - they're optional:

* `favicon.ico`: Favicon.
* `about.html`: About page. Currently not linked from anywhere.
* `_includes/head.html`: Extra stuff in the `<head>` tag.
* `_includes/scripts.html`: Extra stuff before the `</body>` tag.
* `_includes/post-header-home.html`: Customize the post header on the home page.

### Customize the Theme

To change my color theme, edit `_data/theme.yml`.

### Add Your Own CSS

You can customize CSS by editing these files:

* `_sass/custom-bootstrap-variables.scss`: Change Bootstrap variables ([documentation](http://getbootstrap.com/customize)).
* `_sass/custom-scss.scss`: Add your own custom CSS.

### Category Pages

If you want to make category pages, you must manually push the generated `_site` directory to GitHub. If you're still okay with that, [@alextsui05](https://github.com/alextsui05) made an [excellent demo and tutorial for category pages](http://alextsui05.github.io/shiori/categories-in-shiori/). You can see his code on [this pull request](https://github.com/ellekasai/shiori/pull/11).

## :ribbon: Author :ribbon:

#### Elle Kasai

![](https://avatars0.githubusercontent.com/u/2410692?v=2&s=200)

* http://twitter.com/ellekasai
* http://github.com/ellekasai

#### Special Thanks

* [Shu Uesugi](http://github.com/chibicode) - for the guidance on this project.

### License
### The end

[MIT License](http://ellekasai.mit-license.org/)
Like it? [Tell me](http://twitter.com/muanchiou).<br/>
Question? [Use GitHub Issues](https://github.com/muan/scribble/issues).
17 changes: 17 additions & 0 deletions Rakefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
desc "compile and run the site"
task :default do
pids = [
spawn("bundle exec jekyll server -w"),
spawn("scss --watch _assets:stylesheets"),
spawn("coffee -b -w -o javascripts -c _assets/*.coffee")
]

trap "INT" do
Process.kill "INT", *pids
exit 1
end

loop do
sleep 1
end
end
4 changes: 4 additions & 0 deletions _assets/basics.coffee
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
jQuery ->

$.each $("[data-time]"), ( index, ele ) ->
$(ele).html( prettyDate( new Date( $(this).data("time") ) ) )
8 changes: 8 additions & 0 deletions _assets/bourbon/_bourbon-deprecated-upcoming.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
//************************************************************************//
// These mixins/functions are deprecated
// They will be removed in the next MAJOR version release
//************************************************************************//
@mixin box-shadow ($shadows...) {
@include prefixer(box-shadow, $shadows, spec);
@warn "box-shadow is deprecated and will be removed in the next major version release";
}
52 changes: 52 additions & 0 deletions _assets/bourbon/_bourbon.scss
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
// Custom Functions
@import "functions/compact";
@import "functions/deprecated-webkit-gradient";
@import "functions/flex-grid";
@import "functions/grid-width";
@import "functions/linear-gradient";
@import "functions/modular-scale";
@import "functions/px-to-em";
@import "functions/radial-gradient";
@import "functions/render-gradients";
@import "functions/tint-shade";
@import "functions/transition-property-name";

// CSS3 Mixins
@import "css3/animation";
@import "css3/appearance";
@import "css3/background";
@import "css3/background-image";
@import "css3/background-size";
@import "css3/border-image";
@import "css3/border-radius";
@import "css3/box-sizing";
@import "css3/columns";
@import "css3/flex-box";
@import "css3/font-face";
@import "css3/hidpi-media-query";
@import "css3/image-rendering";
@import "css3/inline-block";
@import "css3/keyframes";
@import "css3/linear-gradient";
@import "css3/perspective";
@import "css3/radial-gradient";
@import "css3/transform";
@import "css3/transition";
@import "css3/user-select";
@import "css3/placeholder";

// Addons & other mixins
@import "addons/button";
@import "addons/clearfix";
@import "addons/font-family";
@import "addons/hide-text";
@import "addons/html5-input-types";
@import "addons/position";
@import "addons/prefixer";
@import "addons/retina-image";
@import "addons/size";
@import "addons/timing-functions";
@import "addons/triangle";

// Soon to be deprecated Mixins
@import "bourbon-deprecated-upcoming";
Loading

0 comments on commit bbd1c9f

Please sign in to comment.