mirror-github-bspeice/speice.io
1
0
Fork 0
mirror of https://github.com/bspeice/speice.io synced 2024-11-05 01:28:09 -05:00
Code Issues Releases Wiki Activity
14 Commits 16 Branches 0 Tags 48 MiB
HTML 40.8%
SCSS 31.6%
Ruby 15.6%
CSS 7.7%
Dockerfile 4.3%
8d2d0b39b1
Go to file
Bradlee Speice 8d2d0b39b1 First round of preparation updates
2018-05-20 22:49:21 -04:00
_includes Initial commit for speice.io 2018-05-19 23:06:59 -04:00
_layouts Initial commit for speice.io 2018-05-19 23:06:59 -04:00
_pages First round of preparation updates 2018-05-20 22:49:21 -04:00
_posts Initial commit for speice.io 2018-05-19 23:06:59 -04:00
_sass Initial commit 2017-07-24 10:22:05 +09:00
assets First round of preparation updates 2018-05-20 22:49:21 -04:00
css Initial commit 2017-07-24 10:22:05 +09:00
_config.yml First round of preparation updates 2018-05-20 22:49:21 -04:00
.gitignore Initial commit 2017-07-24 10:22:05 +09:00
.travis.yml Initial commit 2017-07-24 10:22:05 +09:00
404.md Initial commit 2017-07-24 10:22:05 +09:00
favicon.ico First round of preparation updates 2018-05-20 22:49:21 -04:00
feed.xml Initial commit 2017-07-24 10:22:05 +09:00
Gemfile Initial commit 2017-07-24 10:22:05 +09:00
Gemfile.lock Update nokogiri in response to security vulnerability in nokogiri 1.8.0 2018-02-21 19:50:50 -06:00
index.html Silence favicon not found error 2018-05-10 15:22:27 -05:00
LICENSE Initial commit 2017-07-24 10:22:05 +09:00
Rakefile Initial commit 2017-07-24 10:22:05 +09:00
README.md Fix spelling error 2018-05-13 20:42:12 -05:00

README.md

A minimalistic Jekyll Theme


Paper is a minimal Jekyll theme. Perfect for hosting your personal site, blog, or portfolio on GitHub or self-hosting on your own server. The styling is purposely minimalistic so that you can add your own flare to the website.

Live demo of the theme can be seen here. I'm also currently using this theme on my personal blog.

Features

  • Compatible with Jekyll 3.x and Github Pages
  • Live local reloading for faster development
  • Responsive layout built-in
  • Supports Jekyll's built-in Sass/SCSS preprocessor
  • Supports Google Analytics
  • Supports Disqus for commenting
  • Minimum Dependencies
  • Rakefile for automation
    • rake check - Check links/html files of the generated site
    • rake clean - Clean up generated site
    • rake post - Begin a new post in ./_posts
    • rake preview - Preview with livereload on local machine

Usage

git clone https://github.com/mkchoi212/paper-jekyll-theme.git
bundle install
rake preview

Then, go to your favorite brower and type in the address http://127.0.0.1:YOUR_PORT_NUM_HERE to preview your website.

Customization

To customize various details - title/description of the website, your SNS accout names, etc - edit the _config.yml file.

Adding posts

rake post title="A Title" [date="2012-02-09"] [tags=[tag1,tag2]] [category="category"]

This will create a markdown file in the default folder where all posts are stored in Jekyll; _post.

If you wish to change the directory where posts are saved, go to the Rakefile and edit the CONFIG = { 'posts': CUSTOM_PATH_HERE }. This will allow rake post to know where to save the new posts to.

The drafts you are working on can be saved in the _drafts directory. When you push your code to the server, files in this directory will NOT be included to the list o posts.

License

The MIT License (MIT)

Copyright (c) 2017 Mike JS. Choi

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.