Skip to content

Commit

Permalink
Modify readme (#22)
Browse files Browse the repository at this point in the history
  • Loading branch information
hanju-jo authored Sep 21, 2019
1 parent 842b1be commit dbc76dc
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 79 deletions.
58 changes: 58 additions & 0 deletions README.ko.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
# Kiko Now

*Read this in other languages: [English](README.md), [한국어](README.ko.md).*

**Jekyll** 은 GitHub Pages 로 호스팅하는 블로그를 만드는 최적의 정적 사이트 생성기입니다. ([Jekyll Repository](https://github.com/jekyll/jekyll))

**Kiko Now****[Jekyll Now](https://github.com/barryclark/jekyll-now)** 를 기반으로 만들어진 Jekyll 블로그 테마로, 간단한 기본 설정만으로도 블로그를 쉽게 만들 수 있도록 하는 **Jekyll Now** 의 철학을 따르고 있습니다.

## 간단히 시작해볼까요

### Step 1) 이 repository 를 본인의 repository 에 Fork 하세요.

이 repository 를 Fork 하고, repository 이름을 `yourgithubusername.github.io` 로 변경하세요. 그러고 나면 <https://yourgithubusername.github.io> 에서 당신의 Jekyll 블로그를 볼 수 있습니다. (만약 즉시 보이지 않는다면 조금 기다리거나 Step 2 에서 강제로 적용하는 방법이 있습니다.)

*NOTE:* `yourgithubusername` 부분에는 본인의 GitHub 아이디를 입력해야 동작합니다.

### Step 2) 기본 설정을 본인의 것으로 커스터마이징 하세요.

`_config.yml` 파일에서 블로그의 이름, 설명, 아바타 등 다양한 옵션을 수정할 수 있습니다. 구글 애널리틱스, Discus 댓글 시스템, SNS 아이콘 설정도 이곳에서 할 수 있습니다.

`_config.yml` 파일 (또는 repository에 포함된 다른 파일) 을 수정하면 GitHub Pages 에서 자동으로 블로그를 새로고침 합니다. 수정된 블로그는 몇 초 후에 <https://yourgithubusername.github.io> 에서 확인 할 수 있습니다. 만약 바로 나타나지 않으면 GitHub 에서 가이드한 대로 10분 정도 기다려보면 나타날 것입니다.

블로그의 파일을 수정하는 방법은 대략 3가지가 있습니다.
1. 브라우저에서 본인의 repository 를 직접 수정하는 방법(아래 이미지 참고)
2. [Prose](http://prose.io)와 같은 에디터를 사용해서 수정하는 방법(Prose를 사용하면 Jekyll 블로그의 마크다운 수정, 초고 작성, 이미지 업로드 등을 쉽게 할 수 있습니다.)
3. repository를 로컬에 Clone 하고, 로컬에서 수정한 뒤 GitHub 에 Push 하는 방법

![_config.yml](/images/config.png "_config.yml")

### Step 3) 블로그에 첫번째 글을 작성해보세요.

`/_posts/2017-10-08-hello-world.md` 파일을 수정하여 첫번째 글을 작성해보세요. `/_posts/2016-08-14-style-test-ko.md`의 스타일 적용법과 [적용 결과]((https://aweekj.github.io/kiko-now/style-test-ko/))를 참고하면 다양한 스타일을 적용할 수 있습니다.

![First Post](/images/first-post.png "First Post")

브라우저에서 새로운 글을 생성하여 작성할 수도 있습니다.`/_posts/`에서 + 아이콘을 눌러보세요. 두 가지만 주의하면 됩니다. 파일 이름을 `연도-월-일-제목.md` 로 만들고, 파일 상단의 Frontmatter 형식을 지켜주세요.
```
#### Frontmatter
---
layout: post
title: "글 제목"
tags: [태그1, 태그2, 태그3]
comments: true
---
```

## 로컬에서 블로그를 띄워보실 분들을 위하여..

1. Jekyll과 플러그인을 한 번에 설치하는 방법이 있습니다. 성공적으로 설치된다면 GitHub Pages 에서 사용되는 Jekyll, Sass 등이 한 번에 설치됩니다. `gem install github-pages`
2. 본인의 repository 를 로컬에 Clone 합니다. `git clone https://github.com/yourusername/yourusername.github.io.git`
3. 서버를 띄웁니다. `jekyll serve`
4. http://127.0.0.1:4000/ 에서 확인합니다.
5. 변경을 Commit 하고 본인의 repository 에 Push 합니다. 그러면 GitHub Pages 가 자동으로 블로그를 재생성 합니다.

## 질문이 있다면?

[새로운 이슈](https://github.com/aweekj/kiko-now/issues/new)를 등록해주세요.
99 changes: 20 additions & 79 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,20 +1,10 @@
> March, 2016: If you're on an old version of Jekyll Now and run into a) build warnings or b) syntax highlighting issues caused by [Jekyll 3 and GitHub Pages updates](https://github.com/blog/2100-github-pages-now-faster-and-simpler-with-jekyll-3-0), just :sparkles:[update your _config.yml](https://github.com/barryclark/jekyll-now/pull/445/files):sparkles: and you'll be set!
# Kiko Now

# Jekyll Now
*Read this in other languages: [English](README.md), [한국어](README.ko.md).*

**Jekyll** is a static site generator that's perfect for GitHub hosted blogs ([Jekyll Repository](https://github.com/jekyll/jekyll))

**Jekyll Now** makes it easier to create your Jekyll blog, by eliminating a lot of the up front setup.

- You don't need to touch the command line
- You don't need to install/configure ruby, rvm/rbenv, ruby gems :relaxed:
- You don't need to install runtime dependencies like markdown processors, Pygments, etc
- If you're on Windows, this will make setting up Jekyll a lot easier
- It's easy to try out, you can just delete your forked repository if you don't like it

In a few minutes you'll be set up with a minimal, responsive blog like the one below giving you more time to spend on writing epic blog posts!

![Jekyll Now Theme Screenshot](/images/jekyll-now-theme-screenshot.jpg "Jekyll Now Theme Screenshot")
**Kiko Now** is a Jekyll theme based on **[Jekyll Now](https://github.com/barryclark/jekyll-now)**, following the philosophy of **Jekyll Now**, which makes it easier to create your Jekyll blog, by eliminating a lot of the up front setup.

## Quick Start

Expand All @@ -32,21 +22,31 @@ Enter your site name, description, avatar and many other options by editing the

Making a change to _config.yml (or any file in your repository) will force GitHub Pages to rebuild your site with jekyll. Your rebuilt site will be viewable a few seconds later at <https://yourgithubusername.github.io> - if not, give it ten minutes as GitHub suggests and it'll appear soon

> There are 3 different ways that you can make changes to your blog's files:
There are 3 different ways that you can make changes to your blog's files:

> 1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below).
> 2. Use a third party GitHub content editor, like [Prose by Development Seed](http://prose.io). It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy.
> 3. Clone down your repository and make updates locally, then push them to your GitHub repository.
1. Edit files within your new username.github.io repository in the browser at GitHub.com (shown below).
2. Use a third party GitHub content editor, like [Prose by Development Seed](http://prose.io). It's optimized for use with Jekyll making markdown editing, writing drafts, and uploading images really easy.
3. Clone down your repository and make updates locally, then push them to your GitHub repository.

![_config.yml](/images/config.png "_config.yml")

### Step 3) Publish your first blog post

Edit `/_posts/2014-3-3-Hello-World.md` to publish your first blog post. This [Markdown Cheatsheet](http://www.jekyllnow.com/Markdown-Style-Guide/) might come in handy.
Edit `/_posts/2017-10-08-hello-world.md` to publish your first blog post. This [Markdown Cheatsheet](http://www.jekyllnow.com/Markdown-Style-Guide/) might come in handy.

![First Post](/images/first-post.png "First Post")

> You can add additional posts in the browser on GitHub.com too! Just hit the + icon in `/_posts/` to create new content. Just make sure to include the [front-matter](http://jekyllrb.com/docs/frontmatter/) block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md
You can add additional posts in the browser on GitHub.com too! Just hit the + icon in `/_posts/` to create new content. Just make sure to include the [front-matter](http://jekyllrb.com/docs/frontmatter/) block at the top of each new blog post and make sure the post's filename is in this format: year-month-day-title.md

#### Frontmatter
```
---
layout: post
title: "post title"
tags: [tag1, tag2, tag3]
comments: true
---
```

## Local Development

Expand All @@ -56,65 +56,6 @@ Edit `/_posts/2014-3-3-Hello-World.md` to publish your first blog post. This [Ma
4. View your website at http://127.0.0.1:4000/
5. Commit any changes and push everything to the master branch of your GitHub user repository. GitHub Pages will then rebuild and serve your website.

## Moar!

I've created a more detailed walkthrough, [**Build A Blog With Jekyll And GitHub Pages**](http://www.smashingmagazine.com/2014/08/01/build-blog-jekyll-github-pages/) over at the Smashing Magazine website. Check it out if you'd like a more detailed walkthrough and some background on Jekyll. :metal:

It covers:

- A more detailed walkthrough of setting up your Jekyll blog
- Common issues that you might encounter while using Jekyll
- Importing from Wordpress, using your own domain name, and blogging in your favorite editor
- Theming in Jekyll, with Liquid templating examples
- A quick look at Jekyll 2.0’s new features, including Sass/Coffeescript support and Collections

## Jekyll Now Features

✓ Command-line free _fork-first workflow_, using GitHub.com to create, customize and post to your blog
✓ Fully responsive and mobile optimized base theme (**[Theme Demo](http://jekyllnow.com)**)
✓ Sass/Coffeescript support using Jekyll 2.0
✓ Free hosting on your GitHub Pages user site
✓ Markdown blogging
✓ Syntax highlighting
✓ Disqus commenting
✓ Google Analytics integration
✓ SVG social icons for your footer
✓ 3 http requests, including your avatar

✘ No installing dependencies
✘ No need to set up local development
✘ No configuring plugins
✘ No need to spend time on theming
✘ More time to code other things ... wait ✓!

## Questions?

[Open an Issue](https://github.com/barryclark/jekyll-now/issues/new) and let's chat!

## Other forkable themes

You can use the [Quick Start](https://github.com/barryclark/jekyll-now#quick-start) workflow with other themes that are set up to be forked too! Here are some of my favorites:

- [Hyde](https://github.com/poole/hyde) by MDO
- [Lanyon](https://github.com/poole/lanyon) by MDO
- [mojombo.github.io](https://github.com/mojombo/mojombo.github.io) by Tom Preston-Werner
- [Left](https://github.com/holman/left) by Zach Holman
- [Minimal Mistakes](https://github.com/mmistakes/minimal-mistakes) by Michael Rose
- [Skinny Bones](https://github.com/mmistakes/skinny-bones-jekyll) by Michael Rose

## Credits

- [Jekyll](https://github.com/jekyll/jekyll) - Thanks to its creators, contributors and maintainers.
- [SVG icons](https://github.com/neilorangepeel/Free-Social-Icons) - Thanks, Neil Orange Peel. They're beautiful.
- [Solarized Light Pygments](https://gist.github.com/edwardhotchkiss/2005058) - Thanks, Edward.
- [Joel Glovier](http://joelglovier.com/writing/) - Great Jekyll articles. I used Joel's feed.xml in this repository.
- [David Furnes](https://github.com/dfurnes), [Jon Uy](https://github.com/jonuy), [Luke Patton](https://github.com/lkpttn) - Thanks for the design/code reviews.
- [Bart Kiers](https://github.com/bkiers), [Florian Simon](https://github.com/vermluh), [Henry Stanley](https://github.com/henryaj), [Hun Jae Lee](https://github.com/hunjaelee), [Javier Cejudo](https://github.com/javiercejudo), [Peter Etelej](https://github.com/etelej), [Ben Abbott](https://github.com/jaminscript), [Ray Nicholus](https://github.com/rnicholus), [Erin Grand](https://github.com/eringrand), [Léo Colombaro](https://github.com/LeoColomb), [Dean Attali](https://github.com/daattali), [Clayton Errington](https://github.com/cjerrington), [Colton Fitzgerald](https://github.com/coltonfitzgerald), [Trace Mayer](https://github.com/sunnankar) - Thanks for your [fantastic contributions](https://github.com/barryclark/jekyll-now/commits/master) to the project!

## Contributing

Issues and Pull Requests are greatly appreciated. If you've never contributed to an open source project before I'm more than happy to walk you through how to create a pull request.

You can start by [opening an issue](https://github.com/barryclark/jekyll-now/issues/new) describing the problem that you're looking to resolve and we'll go from there.

I want to keep Jekyll Now as minimal as possible. Every line of code should be one that's useful to 90% of the people using it. Please bear that in mind when submitting feature requests. If it's not something that most people will use, it probably won't get merged. :guardsman:
[Open an Issue](https://github.com/aweekj/kiko-now/issues/new) and let's chat!
File renamed without changes.

0 comments on commit dbc76dc

Please sign in to comment.