wiki convention - Gakgu/Gakgu.github.io GitHub Wiki
wiki convention이란 위키를 작성할 때 일관적인 형식으로 작성하기 위해 만든 작성 규칙이다.
인코딩 형식은 utf-8이다. 개행 문자는 LF를 사용한다.
set encoding=utf-8
set fileformat=unix
-
문서 :
위키 내부에 있는 마크다운 형식의 문서. -
항목 :
문서 내부에 있는 내용들을 큰 단위로 묶은 제목. -
리스트 :
마크다운 언어에서 지원하는 리스트를 의미한다.
첫 번째 항목으로 해당 문서에 대한 개요를 작성한다. 개요의 내용은 정의부터 시작한
다.
쉘 스크립트나 명령의 경우 bash shell을 기본으로 한다.
bash shell 명령어를 사용할 때에는 명령어 앞에 $를 사용한다.
특정 리눅스 배포판에 종속된 명령어를 쓰지 않는다. 만약 쓴다면 해당 플랫폼을 함께
적는다.
마크다운 문법은 다음 6 가지만 허용한다.
- 제목1
- 제목2
- 4 스페이스 코드블럭
- 2 스페이스 줄바꿈
- 숫자 뒤에 .이 들어간 순서가 있는 리스트
-
- 기호를 사용하는 순서가 없는 리스트
#의 앞에는 빈 줄이 두 줄 있어야 하며 뒤에 이어지는 내용 사이에는 빈 줄이 없어야
한다.
##의 앞줄에는 빈 줄이 한 줄 있어야 하며 뒤에 이어지는 내용 사이에는 빈 줄이
없어야 한다. 단, ##의 앞에 #가 있다면 그 사이에는 빈 줄이 없어야 한다.
코드블럭이나 리스트의의 뒤에만 빈 줄이 있어야 한다.
코드블럭은 원시 소스나 쉘 명령어 혹은 텍스트 문서의 일부분만 허용된다.
리스트의 하위 내용을 작성해야 할 경우 리스트에 콜론(:)을 붙인 뒤 개행한 후 2줄을
들여쓰기 한 후 작성한다.
리스트위 하위 내용이 있을 경우 리스트와 리스트 사이에는 빈 줄이 있어야 한다.
코드블럭은 4개의 스페이스를 가지고 있어야 하며 위 아래가 빈 줄이어야 한다.
리스트 뒤에 나오는 코드블럭은 그 사이에 위아래가 빈칸인 코드블럭에 대한 설명이
있어야 한다.
리스트 내부에 있는 코드블럭은 8개의 빈 줄을 가진다.
한 줄의 최대 길이는 80자로 제한한다.
문서의 마지막 줄은 빈 줄로 남겨놓는다.