Skip to content

jmquintana79/jmquintana79.github.io-bkp

Repository files navigation

JEKYLL QUICK START

Jekyll Bootstrap is a powerful framework to create easily a static website. On the other hand, GitHub provide a hosting and enviroment to develop and launch this kind of website.

Furthermore, in my case I have use a theme developed by Panos Sakkos to build a more awesome web profile. After of include this theme, I have improved and customized to

1. Host in 3 minutesbe update to my needs.

Host Jekyll project on GitHub is possible setup in only in 3 Minutes. Firstly it is necessary join in GitHub if you are not an account before.

After of this, you can start:

1. Create a New Repository on GitHub

Go to your https://github.com and create a new repository named "USERNAME.github.com"

2. Install Jekyll-Bootstrap on GitHub

Enter these commands into your terminal in a directory you want your blog to be:


$ git clone https://github.com/plusjade/jekyll-bootstrap.git USERNAME.github.com
$ cd USERNAME.github.com
$ git remote set-url origin [email protected]:USERNAME/USERNAME.github.com.git
$ git push origin master

3. Profit

After GitHub has a couple minutes to do your blog will be publicly available at http://USERNAME.github.com.

Already have your blog on GitHub?

When you have installed, run Jekyll-Bootstrap locally to check:


$ git clone https://github.com/plusjade/jekyll-bootstrap.git
$ cd jekyll-bootstrap
$ jekyll serve

See it in action at http://localhost:4000

2. Run Jekyll Locally

In order to preview your blog locally you'll need to install the Jekyll ruby gem.


sudo apt-get install ruby1.9.3 ruby1.9.1-dev nodejs

Note gem dependencies will also be installed. You don't have to run a local version but it helps if you want to preview your content before publishing.


$ gem install jekyll

If you run into a problem please consult the original Jekyll installation documentation.

Once the gem is installed you can navigate to your Jekyll-Bootstrap directory. If you've followed the homepage instructions this will be: USERNAME.github.com. Once in the directory you'll run jekyll with server support:


$ cd USERNAME.github.com 
$ jekyll server --host $IP --port $PORT

Your blog is now available at: http://localhost:4000. In order to stop the server it is only necessary use (Ctr + C). On the other hand, while you are developing or customizing the blog, to update changes is necessary stop and re-start the server.

3. Create a Post

Create posts easily via rake task:


$ rake post title="Hello World"

The rake task automatically creates a file with properly formatted filename and YAML Front Matter. After you have to set your own title while, by default, the date would be set with the current date.

These included post could be Markdown files. This format allow a very easy way to include new content quickly.

4. Create a Page

Create pages easily via rake task:


$ rake page name="about.md"

Create a nested page:


$ rake page name="pages/about.md"

Create a page with a "pretty" path:


$ rake page name="pages/about"
# this will create the file: ./pages/about/index.html

The rake task automatically creates a page file with properly formatted filename and YAML Front Matter as well as includes the Jekyll Bootstrap "setup" file.

5. Publish

After you've added posts or made changes to your theme or other files, simply commit them to your git repo and push the commits up to GitHub.


$ git add .
$ git commit -m "Add new content"
$ git push origin master

A GitHub post-commit hook will automatically deploy your changes to your hosted blog. You will receive a success or failure notice for every commit you make to your blog.

6. Customize

Jekyll-Bootstrap can be used as-is as a basic blogging platform but also it could be customizing deeply:

Themes

Jekyll-Bootstrap supports modular theming. Themes can co-exist and be enabled/disabled on demand. In my case, I have used a theme developed by Panos Sakkos.

Blog Configuration

Jekyll and Jekyll-Bootstrap has a simple but powerful Jekyll Configuration System. You can:

Specify a custom permalink format for blog posts. Specify a commenting engine like disqus, intensedebate, livefyre, or custom. Specify an analytics engine like google, getclicky, or custom.

Jekyll Introduction

I highly recommend reading the Jekyll Introduction if you plan to customize your blog.

Licensing

This work is distributed under the MIT license (LICENSE-JMQuintana.mit) with theme copyright Panos Sakkos from 'PanosSakkos/personal-jekyll-theme'. This one is also distributed under the MIT license (LICENSE-PanosSakkos.mit).