├── .gitignore ├── CHANGELOG.md ├── CNAME ├── Gemfile ├── README.md ├── _config.yml ├── _data └── theme.yml ├── _includes ├── footer.html ├── head.html ├── nav-right.html ├── nav.html ├── post-footer.html ├── post-header-home.html ├── post-header.html ├── ribbon.html ├── scripts.html └── sidebar.html ├── _layouts ├── default.html ├── page.html └── post.html ├── _posts ├── 2014-06-28-example-bootstrap.md ├── 2014-07-27-example-css.md └── 2014-07-28-introducing-shiori.md ├── _sass ├── bootstrap-sass │ ├── _bootstrap-compass.scss │ ├── _bootstrap-mincer.scss │ ├── _bootstrap-sprockets.scss │ ├── bootstrap.scss │ └── bootstrap │ │ ├── _alerts.scss │ │ ├── _badges.scss │ │ ├── _breadcrumbs.scss │ │ ├── _button-groups.scss │ │ ├── _buttons.scss │ │ ├── _carousel.scss │ │ ├── _close.scss │ │ ├── _code.scss │ │ ├── _component-animations.scss │ │ ├── _dropdowns.scss │ │ ├── _forms.scss │ │ ├── _glyphicons.scss │ │ ├── _grid.scss │ │ ├── _input-groups.scss │ │ ├── _jumbotron.scss │ │ ├── _labels.scss │ │ ├── _list-group.scss │ │ ├── _media.scss │ │ ├── _mixins.scss │ │ ├── _modals.scss │ │ ├── _navbar.scss │ │ ├── _navs.scss │ │ ├── _normalize.scss │ │ ├── _pager.scss │ │ ├── _pagination.scss │ │ ├── _panels.scss │ │ ├── _popovers.scss │ │ ├── _print.scss │ │ ├── _progress-bars.scss │ │ ├── _responsive-embed.scss │ │ ├── _responsive-utilities.scss │ │ ├── _scaffolding.scss │ │ ├── _tables.scss │ │ ├── _theme.scss │ │ ├── _thumbnails.scss │ │ ├── _tooltip.scss │ │ ├── _type.scss │ │ ├── _utilities.scss │ │ ├── _variables.scss │ │ ├── _wells.scss │ │ └── mixins │ │ ├── _alerts.scss │ │ ├── _background-variant.scss │ │ ├── _border-radius.scss │ │ ├── _buttons.scss │ │ ├── _center-block.scss │ │ ├── _clearfix.scss │ │ ├── _forms.scss │ │ ├── _gradients.scss │ │ ├── _grid-framework.scss │ │ ├── _grid.scss │ │ ├── _hide-text.scss │ │ ├── _image.scss │ │ ├── _labels.scss │ │ ├── _list-group.scss │ │ ├── _nav-divider.scss │ │ ├── _nav-vertical-align.scss │ │ ├── _opacity.scss │ │ ├── _pagination.scss │ │ ├── _panels.scss │ │ ├── _progress-bar.scss │ │ ├── _reset-filter.scss │ │ ├── _resize.scss │ │ ├── _responsive-visibility.scss │ │ ├── _size.scss │ │ ├── _tab-focus.scss │ │ ├── _table-row.scss │ │ ├── _text-emphasis.scss │ │ ├── _text-overflow.scss │ │ └── _vendor-prefixes.scss ├── custom-bootstrap-variables.scss ├── custom-scss.scss └── pygments-tomorrow.scss ├── about.html ├── archive.html ├── favicon.ico ├── feed.xml ├── index.html ├── javascripts ├── bootstrap.min.js ├── jquery.min.js └── purplecoat-min.js └── stylesheets └── shiori.scss /.gitignore: -------------------------------------------------------------------------------- 1 | _site 2 | .sass-cache 3 | Gemfile.lock 4 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | # 0.1.0 / :ribbon: 2 | 3 | * First release. 4 | -------------------------------------------------------------------------------- /CNAME: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/ellekasai/shiori/524edfa1ea9c402d8b7c768ace93dff0a99fdc96/CNAME -------------------------------------------------------------------------------- /Gemfile: -------------------------------------------------------------------------------- 1 | source "https://rubygems.org" 2 | 3 | gem "github-pages", ">= 25" 4 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | Unfortunately, this project is **no longer maintained**. 2 | 3 | I now have other priorities in my life and no longer have time to update this library. Email me at elle.kasai@gmail.com if you'd like to reach me. 4 | 5 | # :ribbon: Hi! I'm Shiori, a Bootstrap-based Jekyll Theme. :ribbon: 6 | 7 | ![](https://cloud.githubusercontent.com/assets/992008/3955483/2b9a77ae-2702-11e4-9f28-6afb051271de.png) 8 | 9 | ## :ribbon: Live Demo :ribbon: 10 | 11 | ### [You can view the live demo of myself here](http://ellekasai.github.io/shiori). 12 | 13 | ## :ribbon: Screenshots :ribbon: 14 | 15 | ### Desktop/Tablet 16 | 17 | ![](http://cl.ly/image/3a2M1D3E3b3d/screenshot%202014-08-30%20at%206.51.34%20PM.png) 18 | 19 | ## :ribbon: Color Schemes :ribbon: 20 | 21 | I wear different colors (based on [Flat UI Colors](http://flatuicolors.com/)). 22 | 23 | - Dark 24 | - Turquoise 25 | - Green 26 | - Blue 27 | - Purple 28 | - Orange 29 | - Red 30 | 31 | ## :ribbon: Usage :ribbon: 32 | 33 | **Note:** If you're not familiar with Jekyll, please read up on [Jekyll's documentation](http://jekyllrb.com/) first. 34 | 35 | [Fork this repo](http://github.com/ellekasai/shiori/fork), clone it, and then run: 36 | 37 | ``` 38 | bundle install 39 | ``` 40 | 41 | ...which installs `github-pages` gem. After that, run the server: 42 | 43 | ``` 44 | jekyll serve --watch 45 | ``` 46 | 47 | ### :warning: Warning :warning: 48 | 49 | Once the server is started, you must go to [http://localhost:4000/shiori/](http://localhost:4000/shiori/), since `baseurl` is set as `"/shiori"` initially. 50 | 51 | To use http://localhost:4000/, change `baseurl` in `_config.yml` to `""` . 52 | 53 | ### Keeping Shiori Up to Date 54 | 55 | To keep Shiori up to date, follow these steps: 56 | 57 | 1. [Configure a remote for a fork](https://help.github.com/articles/configuring-a-remote-for-a-fork) 58 | 2. [Sync a fork](https://help.github.com/articles/syncing-a-fork) (**Note**: Use `gh-pages` instead of `master`.) 59 | 60 | ## :ribbon: Customization :ribbon: 61 | 62 | ### Required 63 | 64 | You **should** change these files before deploying: 65 | 66 | * `_config.yml`: You must change `baseurl`, `url`, and `title`. Others are optional. 67 | * Make sure to restart the server after you update `_config.yml`. 68 | * `CNAME`: Change this to host Shiori on a custom domain. 69 | * `README.md`: Write your own README! 70 | * `_includes/nav.html`: Modify or remove navigation links. 71 | * `_includes/nav-right.html`: Modify or remove navigation links. 72 | * `_includes/sidebar.html`: Customize the side bar. 73 | * `_includes/post-header.html`: Customize the post header. 74 | * `_includes/post-footer.html`: Customize the post footer. 75 | * `_includes/footer.html`: Add copyright info, etc. 76 | 77 | ### Optional 78 | 79 | You **may** customize these files - they're optional: 80 | 81 | * `favicon.ico`: Favicon. 82 | * `about.html`: About page. Currently not linked from anywhere. 83 | * `_includes/head.html`: Extra stuff in the `` tag. 84 | * `_includes/scripts.html`: Extra stuff before the `` tag. 85 | * `_includes/post-header-home.html`: Customize the post header on the home page. 86 | 87 | ### Customize the Theme 88 | 89 | To change my color theme, edit `_data/theme.yml`. 90 | 91 | ### Add Your Own CSS 92 | 93 | You can customize CSS by editing these files: 94 | 95 | * `_sass/custom-bootstrap-variables.scss`: Change Bootstrap variables ([documentation](http://getbootstrap.com/customize)). 96 | * `_sass/custom-scss.scss`: Add your own custom CSS. 97 | 98 | ### Category Pages 99 | 100 | 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). 101 | 102 | ## :ribbon: Author :ribbon: 103 | 104 | #### Elle Kasai 105 | 106 | ![](https://avatars0.githubusercontent.com/u/2410692?v=2&s=200) 107 | 108 | * http://github.com/ellekasai 109 | 110 | #### Special Thanks 111 | 112 | * [Shu Uesugi](http://github.com/chibicode) - for the guidance on this project. 113 | 114 | ### License 115 | 116 | [MIT License](http://ellekasai.mit-license.org/) 117 | -------------------------------------------------------------------------------- /_config.yml: -------------------------------------------------------------------------------- 1 | baseurl: "/shiori" # The subpath of your site. Use "" if you're hosting a blog at the root level. 2 | url: "http://ellekasai.github.io" # the base hostname & protocol for your site 3 | title: "Shiori" 4 | 5 | # This is used by feed.xml. Uncomment if you want to use it. 6 | # description: "..." 7 | 8 | gems: 9 | - jemoji 10 | exclude: 11 | - "README.md" 12 | - "CHANGELOG.md" 13 | - "CNAME" 14 | - "Gemfile" 15 | - "Gemfile.lock" 16 | permalink: :title 17 | defaults: 18 | - 19 | scope: 20 | path: "" 21 | type: "pages" 22 | values: 23 | layout: "default" 24 | - 25 | scope: 26 | path: "" 27 | type: "posts" 28 | values: 29 | layout: "post" 30 | -------------------------------------------------------------------------------- /_data/theme.yml: -------------------------------------------------------------------------------- 1 | # Theme customization is done on this file instead of _config.yml so that 2 | # you don't have to restart Jekyll to see changes. 3 | 4 | # Number of posts displayed on the home page. 5 | num_home_posts: 3 6 | 7 | # Color scheme based on http://flatuicolors.com/. 8 | # Possible values: 9 | # - default 10 | # - dark 11 | # - turquoise 12 | # - green 13 | # - blue 14 | # - purple 15 | # - orange 16 | # - red 17 | color: default 18 | 19 | # Show navigation below each post? 20 | show_post_navs: true 21 | 22 | # Hides the sidebar. 23 | # You can also hide the sidebar by setting hide_sidebar: true on 24 | # the YAML front matter for each page. 25 | hide_sidebar: false 26 | -------------------------------------------------------------------------------- /_includes/footer.html: -------------------------------------------------------------------------------- 1 | 2 |
3 | ©{{ site.time | date:"%Y" }}. 4 | Built with Jekyll and 5 | Shiori Theme. 6 |
-------------------------------------------------------------------------------- /_includes/head.html: -------------------------------------------------------------------------------- 1 | 2 | -------------------------------------------------------------------------------- /_includes/nav-right.html: -------------------------------------------------------------------------------- 1 | 4 | -------------------------------------------------------------------------------- /_includes/nav.html: -------------------------------------------------------------------------------- 1 |
  • Archive
  • 2 |
  • Download
  • 3 | -------------------------------------------------------------------------------- /_includes/post-footer.html: -------------------------------------------------------------------------------- 1 | 2 |
    3 |

    4 | Post Footer 5 |

    6 |
    7 | {% include ribbon.html %} You can customize this section in _includespost-footer.html. 8 |
    9 |
    -------------------------------------------------------------------------------- /_includes/post-header-home.html: -------------------------------------------------------------------------------- 1 | 2 |
    3 |

    {{ post.date | date_to_string }}

    4 |
    -------------------------------------------------------------------------------- /_includes/post-header.html: -------------------------------------------------------------------------------- 1 | 2 |
    3 |

    {{ page.date | date_to_string }}

    4 |
    5 | {% include ribbon.html %} You can customize this section in _includespost-header.html. 6 |
    7 |
    -------------------------------------------------------------------------------- /_includes/ribbon.html: -------------------------------------------------------------------------------- 1 | 2 | :ribbon: 3 | -------------------------------------------------------------------------------- /_includes/scripts.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | -------------------------------------------------------------------------------- /_includes/sidebar.html: -------------------------------------------------------------------------------- 1 | 2 |
    3 |

    4 | Get Shiori 5 |

    6 | 7 |

    View on GitHub →

    8 | 9 |

    10 | Author 11 |

    12 | 13 |

    14 |

    15 |

    Elle Kasai

    16 |
    17 | Elle Kasai 18 |
    19 |
    20 |

    21 |
    22 | 23 |

    24 | Shiori is Customizable! 25 |

    26 | 27 |

    28 | 29 |

    ↑ Powered by Purplecoat.

    30 | -------------------------------------------------------------------------------- /_layouts/default.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | {% if page.title %}{{ page.title }} | {% endif %}{{ site.title }} 14 | 18 | {% include head.html %} 19 | 20 | 21 | {% if site.data.theme.color == "default" %} 22 |