Skip to content

Latest commit

 

History

History
71 lines (49 loc) · 3.45 KB

README.md

File metadata and controls

71 lines (49 loc) · 3.45 KB
Raw

tupleblog

Repository for tupleblog (in Thai) based on Jekyll HPSTR theme.

Write on Gitpod

Gitpod is an amazing online IDE especially for GitHub. You can start writing the blog on Gitpod by clicking here and logging in with your GitHub Authentication.

tpb script

tpb script is now live! tpb.sh will help you install and serve the site easily. All you need to have is Ruby version >= 2.5.3.

Here is how the script looks like:

$ ./tpb.sh
Usage: ./tpb.sh [-i] [-d]

  Options:
    -i, --install     install dependencies with gem (gem install bundler) and bundler (bundle install).
    -d, --debug       serve jekyll locally using bundler.

If you have already installed Ruby, you can go ahead with the command ./tpb.sh -i. This will install bundler if it is not installed yet and then run bundle install for you. Another command is ./tpb.sh -d for debugging locally. This command starts with commenting specified url in the _config.yml of the project then serving Jekyll with JEKYLL_ENV=production prefix. It also uncomments the line for you when you stop the server by hitting ctrl+c.

Running the blog locally

First, go to _config.yml then change line 9 for running locally. Then, change directory to the repository and then do the following

  1. run ruby --version to check if there is already ruby on your system. If there is skip to step 3, else do step 2.
  2. Download ruby using Homebrew for Mac. For Windows, download RubyInstaller and DEVELOPMENT KIT regarding your OS architecture from here. For RubyInstaller, just double click and done. For DEVELOPMENT KIT, please follows its instruction.
  3. Update your installed gems to latest version gem update. If updating failed try running gem update --system to update its core (see this post).
  4. gem install bundler
  5. bundle install (For Windows, run cmd as Administrator)
  6. bundle exec jekyll serve to serve the site in port 4000. You can also run with drafts using bundle exec jekyll serve --drafts

Contribution by Pull Request

  • Add your profile to _data/authors.yml file. You can put your avatar image in images/avatar folder

  • All posts on the website are all located in _posts folder where the post name format is yyyy-mm-dd-post-name.md. Jekyll uses markdown format for the post which can be easily written. We can provide header of each post (markdown file) as

---
layout: post
title: "Post Title"
author: Titipata (author id from authors.yml)
description: "Short description for the post"
modified: 2014-12-13
tags: [post, title, example]
comments: false (or true if you want people to leave a comment)
---

After the header of each post, you can simply write down a post. You can see example or previous posts in the _posts folder

Members