https://github.com/mkchoi212/paper-jekyll-theme

A minimal Jekyll theme for personal blogs
https://github.com/mkchoi212/paper-jekyll-theme

jekyll jekyll-blog jekyll-theme

Last synced: 18 days ago
JSON representation

A minimal Jekyll theme for personal blogs

• Host: GitHub
• URL: https://github.com/mkchoi212/paper-jekyll-theme
• Owner: mkchoi212
• License: mit
• Created: 2017-07-21T01:49:26.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2023-01-20T09:46:25.000Z (almost 2 years ago)
• Last Synced: 2024-08-01T00:39:48.842Z (3 months ago)
• Topics: jekyll, jekyll-blog, jekyll-theme
• Language: CSS
• Homepage: https://deadbeef.me/paper-jekyll-theme/
• Size: 221 KB
• Stars: 197
• Watchers: 5
• Forks: 133
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        


  

  


  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](https://deadbeef.me/paper-jekyll-theme/). I'm also currently using this theme on my [personal blog](https://www.deadbeef.me).

## 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 of posts.

# License

Please see [LICENSE](./LICENSE)