Skip to content
Yeongtaek Hong edited this page Jan 31, 2016 · 1 revision

Welcome to the cclguide wiki!

Developement

requirements

ruby 2.1.1 # rbenv install 2.1.1
gem github-pages # bundle install
```

### structure

```
# 개발용 설정 파일 등
.editorconfig
.gitignore
.ruby-version
.sass-cache
CNAME
Gemfile
Gemfile.lock

# 라이선스 및 프로젝트 문서
LICENSE
README.md

# 설정 및 데이터
_config.yml
_data # 초기 화면 배너, 대표 페이지, 쇼케이스 노출 관리, 사이트 메뉴, 각종 분류, 라이선스 선택기 텍스트 데이터

# 초기 화면
index.html 
front # 초기 화면 이미지 업로드 및 페이징 페이지

# 템플릿과 프론트엔드 에셋
_includes # 스니펫들
_layouts # 레이아웃
_sass # sass mixins
css # 스타일시트 / 기본 스타일에 추가
js # lunrjs, 라이선스 선택기 등
fonts 
images
_site # 실제 빌드된 결과물 디렉토리 (웹루트 docroot)

# 콘텐츠
_showcases # 적용 사례 문서들
_resources # 쉽게 이해하는 CC 라이선스 문서들
_faqs # 자주묻는질문 문서들
pages # 주요 페이지 문서
paging # 콜렉션, 분류별 페이징을 위한 페이지

# prose.io
links.jsonp
media # 이미지 등 업로드 디렉토리

```

### _config.yml

```
아래는 기본 설정 중 수정할 만한 것들입니다.

# 공유용 대표 이미지 (트위터 페북 카드 이미지)
default_image: '/images/share/ccl_sns_img_green.jpg'

# 첫화면 하단 쇼케이스 페이징 포스트 개수
paging_front_showcases: 4

# 각종 목록 화면 페이징 포스트 개수
paging_list_showcases: 30 # 적용 사례
paging_list_faqs: 30 # 자주 묻는 질문
paging_list_resources: 30 # 03. 쉽게 이해하는 CC 라이선스 

아래에는 콜렉션 정의와 prose.io 설정을 살펴보세요.

```

### _data

```
# 사이드바 글로벌 메뉴
nav.yml 

# 초기화면
shortcuts.yml # 대표 페이지 링크 지정
banners.yml # 1단, 2단 이미지 배너 설정
showcases.yml # 하단 쇼케이스 노출

# 콜렉션 분류: 각 목록 화면의 분류 서브 네비게이션.
showcases-categories.yml
resources-categories.yml
faqs-categories.yml

# 라이선스 선택기 문자열 => js/license.js
licenses.yml

```

### collections
콜렉션은 워드프레스의 post type, 드루팔의 contents type과 비슷한 개념으로 페이지나 포스트는 콜렉션의 서브셋입니다. 특정 형식의 문서들의 집합체로써 리퀴드 템플릿에서 `site.showcase` 이런 식으로 전체 쇼케이스 형식의 문서의 배열에 접근할 수 있습니다.

> 페이지나 포스트가 전부는 아닙니다. 자신의 오픈 소스 프로젝트에 포함된 다양한 메소드나 팀 멤버들의 목록, 또는 컨퍼런스 대화 내역들을 문서화하려는 경우도 생각해볼 수 있습니다. 콜렉션 기능을 사용하면 기본적으로는 페이지나 포스트처럼 동작하지만, 고유한 네임스페이스와 속성이 추가된 새로운 종류의 문서를 정의할 수 있습니다.
from <http://jekyllrb-ko.github.io/docs/collections/>

- showcase: 적용 사례 / <http://ccl.cckorea.org/about/showcases/>
- resources: 쉽게 이해하는 CC 라이선스 / <http://ccl.cckorea.org/about/resources/>
- faqs: 자주 묻는 질문 / <http://ccl.cckorea.org/faq/>

### pages

```
about # 01. CC 라이선스 소개
application # 02. CC 라이선스 적용
reuse # 03. CC 라이선스 콘텐츠 이용
faq.html # 04. 자주 묻는 질문
cckorea.md # 05. 크리에이티브커먼즈 소개

404.html # 404 페이지
syntax.md # 마크다운 문법 소개
vision.md
```

### javascripts

- [pklauzinski/jscroll](https://github.com/pklauzinski/jscroll) - 무한 스크롤
- [codepiano/lunr.js](https://github.com/codepiano/lunr.js), 중국어 검색 지원 - fork of [olivernn/lunr.js](https://github.com/olivernn/lunr.js) - 검색 (한글 검색 완벽하지 않음.)

Clone this wiki locally