Skip to content

Latest commit

 

History

History
191 lines (129 loc) · 5.57 KB

README.md

File metadata and controls

191 lines (129 loc) · 5.57 KB

My Blog Url: https://jhonjairocruz.com/. If you like this theme, you can give me a star to encourage me. Welcome everyone to use it.

Content

Page Details

Home

Index page show 5 posts excerpt as a default. Readers can click article title or read more button to see full post. There are recent posts area, categories area and tags area at the right part of the index page. You can also add an area at this part, if you change the file index.html.

Archives

Archive post according to the year.

Categories

Show posts according to the category.

Tags

Show posts according to the tags.

About

HTML5 style CV, feel free to edit if you want.

Comments

This theme supports disqus. It's very easy to config your comments module.

The only thing you need do is to change the short_name in the file _config.yml. As follows.

Post Contents

The post contents is fixed at the right side while page is scrolling. There will be a scroll bar on contents while it is outside the window height.

Code Highlight

While the jekyll is update to 3.x.x, you can use github flavored markdown to write code.

More info to see syntax-highlighter-changed.

Usage

Feel free to use this theme fork it, this part shows introduction to use.

1. Install ruby and jekyll environment

This step and Step 5 mainly talk to you how to launch blog at local. If you don't want to launch at local, you can ignore these 2 steps. But I still strongly suggest to do this. Ensure there is nothing wrong before pushing to the github.

The Windows users can directly use RubyInstaller to install ruby environment. Follow the prompts while installing.

Install jekyll commands:

gem install jekyll

For more details, you can view the jekyll official website. https://jekyllrb.com/

There may be something wrong at mac OS X El Capitan, you can see the solution at https://jekyllrb.com/docs/troubleshooting/#jekyll-amp-mac-os-x-1011.

If you are interesting in jekyll, you can see the jekyll source code at https://github.com/jekyll/jekyll.

jekyll logo

2. Copy theme code

You can clone, download or fork this repo.

3. Change parameter

Mainly change the parameters at file _config.yml and use your own favicon.ico.

Basic info

Shows at site header part.

# Site settings
title: Jhon Jairo Cruz
brief-intro: Fullstack Dev Engineer
baseurl: "" # the subpath of your site, e.g. /blog
url: "https://jhonjairocruz.com" # the base hostname & protocol for your site

Link info

Mainly shows at the footer of the site.

# other links
twitter_username: Jjairocj
facebook_username: jhonjairocruzoficial
github_username:  Jjairocj
email: [email protected]
linkedIn_username: jhonjairocruzjimenez
whatsapp_username: XXXXXXXXX
instagram_username: enfocaalmundo

description_footer: A veces tienes que desesperarte un poco para poder llegar a algún lado  !

4. Write post

You can write posts at folder _posts. At the beginning of the post, you should declare layout、title、date、categories、tags、author(optional) info、mathjax(optional,click here for more detail about Mathjax).

---
layout: post
title:  "Tu titulo"
date:   1990-11-18 14:00:18 +0800
categories: jekyll
tags: jekyll markdown Foxit RubyGems HTML CSS
author: Jhon Jairo Cruz
mathjax: true
---

These follow code is for making contents.

* content
{:toc}

You can use 4 wraps as a excerpt separator. The words before separator as excerpt show in the index page. When you enter the post page, you can read full article.

The wraps config is in the file _config.yml, as follows:

# excerpt
excerpt_separator: "\n\n\n\n"

You should use markdown syntax to write article, just like write readme in github.

You can use 3 ``` to write code block.

5. Local launch

use command:

jekyll s

Terminal shows:

Configuration file: E:/GitWorkSpace/blog/_config.yml
            Source: E:/GitWorkSpace/blog
       Destination: E:/GitWorkSpace/blog/_site
 Incremental build: disabled. Enable with --incremental
      Generating...
                    done in 6.33 seconds.
  Please add the following to your Gemfile to avoid polling for changes:
    gem 'wdm', '>= 0.1.0' if Gem.win_platform?
 Auto-regeneration: enabled for 'E:/GitWorkSpace/blog'
Configuration file: E:/GitWorkSpace/blog/_config.yml
    Server address: http://127.0.0.1:4000/
  Server running... press ctrl-c to stop.

Visit localhost:4000 to see your blog!!!

6. Push to GitHub

If there is nothing wrong, push code to your github!

License

MIT License