wiki 페이지 관리

본 문서에서는 wiki에 기여하고자 하는 개발자 분들을 위한 wiki page의 작성 및 편집 방법을 기술합니다.

페이지 추가

• repository 기본 페이지에서 wiki 메뉴를 선택합니다.

• 페이지의 오른쪽 상단 모서리에서 New page 를 클릭합니다.

• 텍스트 편집기를 사용하여 페이지의 콘텐츠를 추가합니다.

• 추가하려는 새 파일을 설명하는 커밋 메시지를 입력합니다.

• Wiki에 변경 내용을 커밋하려면 Save page 를 클릭합니다.

페이지 편집

• repository 기본 페이지에서 wiki 메뉴를 선택합니다.

• Wiki 사이드바를 사용하여 변경할 페이지로 이동합니다. 페이지의 오른쪽 상단 모서리에서 Edit 를 클릭합니다.

• 텍스트 편집기를 사용하여 페이지의 콘텐츠를 편집합니다.

• 변경 내용을 설명하는 커밋 메시지를 입력합니다.

• Wiki에 변경 내용을 커밋하려면 Save page 를 클릭합니다.

Side bar 편집

추가된 페이지는 우측 메뉴에 추가되지만, 편의성을 위해 Side bar에 추가가 권장됩니다.
노하우 및 기술 문서는 Side bar 메뉴의 기술 문서 하위에 추가 바랍니다.

• 우측 Side bar에서 수정 버튼을 클릭합니다.

• 텍스트 편집기를 사용하여 페이지의 콘텐츠를 편집합니다.

• 변경 내용을 설명하는 커밋 메시지를 입력합니다.

• Wiki에 변경 내용을 커밋하려면 Save page 를 클릭합니다.

로컬 환경에서의 편집

Github는 Wiki에 대한 Repository를 제공하여 로컬에서 편집할 수 있습니다.

• 우측 메뉴의 Clone this wiki locally 의 url을 복사합니다.
• 로컬 환경에 repository를 복제합니다.

$ git clone https://github.com/YOUR_USERNAME/YOUR_REPOSITORY.wiki.git
# Clones the wiki locally

Wiki 파일 이름 정보

파일 이름은 Wiki 페이지의 제목을 결정하며 파일 확장명은 Wiki 콘텐츠가 렌더링되는 방법을 결정합니다.

Wiki는 오픈 소스 태그 라이브러리를 사용하여 태그를 변환하고 파일 확장에서 사용할 변환기를 결정합니다. 예를 들어 파일 이름이 foo.md 또는 foo.markdown인 경우 Wiki는 Markdown 변환기를 사용하며, 파일 이름이 foo.textile인 경우에는 Textile 변환기를 사용합니다.

Wiki 페이지의 제목에 다음 문자를 사용하지 마세요. \ / : * ? " < > | 특정 운영 체제의 사용자는 문자가 포함된 파일 이름을 사용할 수 없습니다. 확장과 일치하는 태그 언어를 사용하여 콘텐츠를 작성해야 하며, 그렇지 않으면 콘텐츠가 제대로 렌더링되지 않습니다.